@vue-flow/monorepo • Docs

---

Interface: BackgroundProps

Properties

bgColor?

optional bgColor: string

Deprecated

• will be removed in the next major version. You can assign a bg color to <VueFlow /> directly instead. Background color

---

color?

optional color: string

Background pattern color

---

gap?

optional gap: number | number[]

Background pattern gap

---

height?

optional height: number

Deprecated

Background height

---

id?

optional id: string

---

lineWidth?

optional lineWidth: number

---

offset?

optional offset: number

Background offset

---

patternColor?

optional patternColor: string

Deprecated

• will be removed in the next major version. Use color instead Background pattern color

---

size?

optional size: number

Background pattern size

---

variant?

optional variant: "lines" | "dots" | BackgroundVariant

The background pattern variant

---

width?

optional width: number

Deprecated

Background width

---

x?

optional x: number

Background x-coordinate (offset x)

---

y?

optional y: number

Background y-coordinate (offset y)