@oasislabs/style

oasis-style

Universal Oasis styling, as per our design guidelines.

Usage

This repository comes with two projects:

1. A global Bulma-lite* css framework that can be imported into a project and used agnostic of any javascript framework
2. A set of Vue components that can be used in any Vue project

1. Using the css framework

Import oasis.scss into an existing project. The project must be able to build scss files correctly (using scss-loader in webpack for example)

import 'oasis-style'

More documentation will come once this framework takes shape.

2. Using the Vue components

Import oasis.scss into the top-level component. The project must be able to build scss files correctly (using scss-loader in webpack for example)

import 'oasis-style'

Import and use any component available in styles/vue/components

import { Button } from 'oasis-style/vue/components'

More documentation will come once this framework takes shape.

Development

To help facilitate the development of new components, Storybook has been added.

When developing new components, create a story along with it.

To run storybook,

npm install
npm run storybook

Today, Storybook is set up for Vue, but it can also be added for other frameworks in the future