README.md

Bonn

Convenient utility, style and components library for web projects:

• JavaScript utilities
• SCSS mixins, variables and default styles
• SVG icon set
• Vercel endpoint helpers
• GitHub actions code
• Vue and Nuxt apps
  • Vue components
  • Vue composables
  • Pinia stores
  • Nuxt head and config helpers

Utilities can be used in any JS project, including server-side. Similarly, SCSS and SVGs can be used in any project, not only Vue or Nuxt projects.

Installation

Install Bonn and (optional) dependencies:

npm i bonn lodash-es date-fns

You might need additional peer dependencies depending on the type of project and the components you use. See the relevant docs for more details.

Setup on Nuxt

Use the nuxt.config helpers to load Bonn's Nuxt module and other relevant configurations:

import {
  mergeConfigs,
  bonn,
  scss,
  svg
} from 'bonn/nuxt/config/bonn'

export default defineNuxtConfig(mergeConfigs(
  // You'll probably want to enable SCSS and SVG in your Nuxt app
  scss(),
  svg(),

  // Enable Bonn
  bonn({
    // components: false,
    // composables: false,
    // icons: false,
    // prefix: 'Bonn'
  }),

  // Add your own Nuxt config here...
  {
    // ...
  }
))

Usage

.js utilities

import formatFileSize from 'bonn/utils/formatFileSize'

formatFileSize(19238028)

.vue components

components/ are NOT built during install. You must transpile them yourself in your project.

<script>
import ClickButton from 'bonn/components/ClickButton'

export default {
  components: {
    ClickButton
  }
}
</script>

<template>
  <ClickButton />
</template>

Note that when using <script setup>, you don't have to export the components. In a Nuxt project, components are also auto imported so you can directly use them in your templates.

Vue composables

import useIsMounted from 'bonn/composables/useIsMounted'

const isMounted = useIsMounted()

export default {
  data () {
    return {
      isMounted
    }
  }
}

Pinia stores/

import useDevice from 'bonn/stores/device'

const device = useDevice()

nuxt.config helpers

import { mergeConfigs, dev, assets, scss, svg } from 'bonn/nuxt/config'

export default defineNuxtConfig(mergeConfigs(
  assets({ /*...*/ }),
  scss({
    global: 'styles/global.scss',
    shared: 'styles/shared.scss'
  }),
  svg(),
  dev({
    typescript: {
      shim: false
    }
  })
))

.svg icons

Auto imported in a Nuxt project:

<Icon>
  <IconChevronUp />
</Icon>

The Icon component renders the SVG assets in a standard size, but is not required.

.scss mixins and styles

scss/ contains useful, generic mixins and functions for developing web sites and apps. It is designed to be compatible with components/, but can be used independently.

import formatFileSize from 'bonn/utils/formatFileSize'

formatFileSize(19238028)

In your SCSS code, import everything:

@import 'bonn/scss';

Basic customisation:

@import 'bonn/scss/shared';

@import './my-variables';   // Override default SCSS variables here

@import 'bonn/scss/global'; // CSS variables, normalisation and defaults
@import 'bonn/scss/utils';   // Optional

Advanced customisation:

// shared.scss
@import 'bonn/scss/variables-scss';
@import 'bonn/scss/functions';
@import 'bonn/scss/mixins';

// Custom SCSS variables
@import './my-variables';

// Normalizations and defaults (these output CSS)
@import 'bonn/scss/variables';
@import 'bonn/scss/normalize';
@import 'bonn/scss/defaults';
@import 'bonn/scss/utils';

You can optimise your build even further by including only some defaults and utilities:

@import 'bonn/scss/defaults/body';
@import 'bonn/scss/defaults/forms';
@import 'bonn/scss/defaults/tables';

@import 'bonn/scss/utils/bodytext';

Import from a JavaScript file:

import 'bonn/scss/shared';
import 'bonn/scss/global';
import 'bonn/scss/utils';