@milkfloat/components

The Halo Component Library

This is currently under development.

Getting Started

You can view and interact with this library using our UI Workshop powered by Storybook.

To contribute, see our guidance documentation at halo-ui-guidance for some guidance on coding best practice and standards.

Optional Dependencies

Certain components within the Halo library make use of Moasic (Lowside Stub) components from GLib. To make use of these lowside components you will need to update your .npmrc file with the registry location and authToken to allow npm to find the libaries.

npm login --registry=<Glib Registry> --scope=@glib

Available Scripts

In the project directory, you can run:

npm run storybook

Runs the UI Workshop for the Library.
Open http://localhost:9009 to view it in the browser.

The page will reload if you make edits.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Prettifies the codebase to meet coding standards then creates a dist version of the library which will be used by peer projects. Note that you will need to run this for peers to be able to use the updated codebase.

About the build process

We use kcd-scripts to provide our utility scripts and tools for development. These include babelifying our codebase ready for distribution and linting utility. These are easily extended via the standard configuration files for babel and prettier. See: https://github.com/kentcdodds/kcd-scripts

TODO

For developers looking to contribute to this project, please consider helping out on the following:

• Add Application Icon style
• Add Breadcrumb component
• Theme override / extension
• Build up documentation