# @vue-flow/background

> This is a background component for Vue Flow. It can be used to create a background in your canvas.

Latest version **1.3.2** (published 2024-11-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install @vue-flow/background
pnpm add @vue-flow/background
yarn add @vue-flow/background
bun add @vue-flow/background
```

## Health

**Score 50/100 (C)** — status: stable.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 1.3.2 |
| Published | 2024-11-13 |
| First published | 2022-12-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 22.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 6914 |
| Author | Burak Cakmakoglu |
| Maintainers | braks |
| Keywords | vue, flow, diagram, editor, graph, node, link, port, slot, vue3, composition-api, vue-flow, vueflow, typescript |

## Links

- npm: https://www.npmjs.com/package/@vue-flow/background
- Repository: https://github.com/bcakmakoglu/vue-flow/packages/plugins/background
- Homepage: https://github.com/bcakmakoglu/vue-flow#readme
- Issues: https://github.com/bcakmakoglu/vue-flow/issues
- npm.io page: https://npm.io/package/@vue-flow/background

## Recent versions

- 1.3.2 (latest) — 2024-11-13
- 1.3.1 — 2024-11-01
- 1.3.0 — 2024-02-15
- 1.2.0 — 2023-04-11
- 1.1.0 — 2023-03-23
- 1.0.5 — 2023-02-24
- 1.0.4 — 2023-02-15
- 1.0.3 — 2023-01-18
- 1.0.2 — 2023-01-06
- 1.0.1 — 2022-12-29
- 1.0.0 — 2022-12-13

## README

# Vue Flow: Background Component

This is a background component for Vue Flow.
It can be used to create a background in your canvas.

## 🛠 Setup

```bash
# install
$ yarn add @vue-flow/background

# or
$ npm i --save @vue-flow/background
```

## 🎮 Quickstart

```vue
<script setup>
import { VueFlow } from '@vue-flow/core'
import { Background } from '@vue-flow/background'
import initialElements from './initial-elements'

// some nodes and edges
const elements = ref(initialElements)
</script>

<template>
  <VueFlow v-model="elements" fit-view-on-init class="vue-flow-basic-example">
    <Background />
  </VueFlow>
</template>
```

---
_Source: https://npm.io/package/@vue-flow/background · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._