types.ts

/**
 * @deprecated - will be removed in the next major version. You can use simple string values for `variant` prop instead, i.e. `lines` or `dots`
 */
export enum BackgroundVariant {
  Lines = 'lines',
  Dots = 'dots',
}

export type BackgroundVariantType = Lowercase<keyof typeof BackgroundVariant>

export interface BackgroundProps {
  id?: string
  /** The background pattern variant */
  variant?: BackgroundVariant | BackgroundVariantType
  /** Background pattern gap */
  gap?: number | number[]
  /** Background pattern size */
  size?: number
  lineWidth?: number
  /**
   * @deprecated - will be removed in the next major version. Use `color` instead
   * Background pattern color
   */
  patternColor?: string
  /** Background pattern color */
  color?: string
  /**
   * @deprecated - will be removed in the next major version. You can assign a bg color to `<VueFlow />` directly instead.
   * Background color
   */
  bgColor?: string
  /** @deprecated Background height */
  height?: number
  /** @deprecated Background width */
  width?: number
  /** Background x-coordinate (offset x) */
  x?: number
  /** Background y-coordinate (offset y) */
  y?: number
  /** Background offset */
  offset?: number
}