@visual-framework/vf-component-library
v1.2.14
Published
Generate a static-html site of Visual Framework components and docs.
Downloads
77
Readme
Visual Framework component library
The homepage, welcome and onboarding site for the Visual Framework and its components.
What's the Visual Framework?
Local development
You'll need to install npm and then:
- If you don't have
yarn
, install it- https://yarnpkg.com/lang/en/docs/install/
- Install all the things
yarn install
- Generate the site in
/build
gulp dev
renders and servesgulp build
build static assets
Adding Visual Framework components
To add a component, use the command line or install it manually.
By package
- installation:
yarn add @visual-framework/vf-logo
- updating components:
yarn upgrade-interactive --latest
- alias:
yarn run update-components
- alias:
Manual installation for customisation
- Download a pattern
- Copy it to
./src/components/vf-component-name
Footnotes
- Why
yarn
and notnpm
? For the particular structure of the Visual Framework components, Yarn is considerably faster at installing and does so more efficiently (about half the total file size). You'll also be able to useyarn upgrade-interactive --latest
, which makes it easier to update VF components.