# nuxt-buefy

> Nuxt buefy

Latest version **0.4.29** (published 2024-04-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install nuxt-buefy
pnpm add nuxt-buefy
yarn add nuxt-buefy
bun add nuxt-buefy
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.4.29 |
| Published | 2024-04-01 |
| First published | 2018-02-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8.0.0 |
| Dependencies | 1 |
| Unpacked size | 6.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 220 |
| Maintainers | wesdevpro, rafaelpimpa, jtommy, anteriovieira |

## Links

- npm: https://www.npmjs.com/package/nuxt-buefy
- Repository: https://github.com/buefy/nuxt-buefy
- Homepage: https://github.com/buefy/nuxt-buefy#readme
- Issues: https://github.com/buefy/nuxt-buefy/issues
- npm.io page: https://npm.io/package/nuxt-buefy

## Dependencies (1)

- [buefy](https://npm.io/package/buefy.md) ^0.9.29

## Recent versions

- 0.4.29 (latest) — 2024-04-01
- 0.4.28 — 2024-02-15
- 0.4.27 — 2024-01-03
- 0.4.26 — 2023-10-03
- 0.4.25 — 2023-03-07
- 0.4.24 — 2022-09-12
- 0.4.23 — 2022-05-21
- 0.4.22 — 2022-04-17
- 0.4.21 — 2022-03-02
- 0.4.20 — 2022-03-02
- 0.4.19 — 2022-03-01
- 0.4.18 — 2022-02-21
- 0.4.17 — 2022-02-18
- 0.4.16 — 2022-02-16
- 0.4.15 — 2022-02-16
- … 57 more at https://npm.io/package/nuxt-buefy/versions

## README

# nuxt-buefy
[![npm (scoped with tag)](https://img.shields.io/npm/v/nuxt-buefy/latest.svg?style=flat-square)](https://npmjs.com/package/nuxt-buefy)
[![npm](https://img.shields.io/npm/dt/nuxt-buefy.svg?style=flat-square)](https://npmjs.com/package/nuxt-buefy)
[![CircleCI](https://img.shields.io/circleci/project/github/buefy/nuxt-buefy.svg?style=flat-square)](https://circleci.com/gh/buefy/nuxt-buefy)
[![Codecov](https://img.shields.io/codecov/c/github/buefy/nuxt-buefy.svg?style=flat-square)](https://codecov.io/gh/buefy/nuxt-buefy)
[![Dependencies](https://david-dm.org/buefy/nuxt-buefy/status.svg?style=flat-square)](https://david-dm.org/buefy/nuxt-buefy)
[![js-standard-style](https://img.shields.io/badge/code_style-buefy-7957d5.svg?style=flat-square)](http://buefy.github.io)

> It's really very simple to start with nuxt. But we can make it even simpler by adding <a href="https://github.com/buefy/nuxt-buefy">nuxt-buefy</a>.

[📖 **Release Notes**](./CHANGELOG.md)

## Install

If you create new project from scratch, just choose buefy right from create-nuxt-app!

For already existing project just:

```bash
npm i nuxt-buefy
# or
yarn add nuxt-buefy
```

### TypeScript support

Add `buefy/types` to `tsconfig.json`:

```js
{
  "compilerOptions": {
    "types": [
      "buefy/types"
    ]
  }
}
```

## Usage

```js
{
  modules: [
    // Simple usage
    'nuxt-buefy',

    ['nuxt-buefy', { /* buefy options */ }]
 ]
}
```

or 

```js
{
  modules: [
    // Simple usage
    'nuxt-buefy',
 ],
 buefy: { /* buefy options */ }
}
```

### Options

Name | Description | Type | Values | Default |
-----|-------------|------|--------|---------|
`css`     | Add buefy css | Boolean | `true` or `false` | `true` |
`materialDesignIcons` | Add material design icons | Boolean | `true` or `false` | `true` |
`materialDesignIconsHRef` | Specify material design icons version | String | Any CDN URL to MDI | `https://cdn.jsdelivr.net/npm/@mdi/font@5.8.55/css/materialdesignicons.min.css` |

> You can use buefy [construct options](https://buefy.org/documentation/constructor-options).

### Customization

If you're familiar with Sass and want to customize Buefy with your own theme, follow these steps:

0. If not already installed, install `sass` and `sass-loader`

```bash
npm i sass sass-loader@10 --save-dev
# or
yarn add --dev sass sass-loader@10
```

1. Disable buefy css in module options:

```js
{
  modules: [
    ['nuxt-buefy', { css: false }]
 ]
}
```

2. Create a `.scss` file:

```css
// Import bulma styles
@import "~bulma";

// Import buefy styles
@import "~buefy/src/scss/buefy";
```

3. Define `css` property in `nuxt.config`:

```js
{
  css: ['@/assets/scss/main.scss']
}
```

## Development

- Clone this repository
- Install dependnecies using `yarn install` or `npm install`
- Start development server using `yarn run dev` or `npm run dev`

## License

[MIT License](./LICENSE)

Copyright (c) Rafael Beraldo

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