Skip to content

Set of FlowForge-themed VueJS components that can be used in any FlowForge web applications.

License

Notifications You must be signed in to change notification settings

FlowFuse/forge-ui-components

Folders and files

NameName
Last commit message
Last commit date

Latest commit

d4eb478 · Mar 15, 2023
Nov 14, 2022
Jun 21, 2022
Mar 15, 2023
Mar 1, 2022
Mar 15, 2023
Nov 14, 2022
Mar 9, 2023
Nov 14, 2022
Mar 1, 2022
Apr 14, 2022
Oct 24, 2022
Oct 24, 2022
Mar 15, 2023
Mar 1, 2022
Dec 6, 2022
Dec 5, 2022
Jun 17, 2022

Repository files navigation

FlowForge UI Components

Detailed documentation on each of the available components (including examples) can be found here: https://flowforge.github.io/forge-ui-components/

How to use

In order to include these Vue components into an existing VueJs project, include the following in your main.js file:

// Import FlowForge UI Vue Components
import ForgeUIComponents from '@flowforge/forge-ui-components'
// Import FlowForge UI Component Styling
import '@flowforge/forge-ui-components/dist/forge-ui-components.css'

createApp()
    .use(ForgeUIComponents)
    .mount(...)

Contributing

Build Library

npm install
npm run build

In order to build the project, ready for publishing and use, run the npm run build command. This will output three files: into /dist:

/dist/forge-ui-components.css
/dist/forge-ui-components.js
/dist/forge-ui-components.mjs

Build Documentation

npm run build-docs

The GitHub pages documentation is built into /dist/docs (defined in vue.config.js). It is configured as a subtree of the GitHub repo on the gh-pages branch.

Running Documentation

npm run serve

The documentation should then become available at http://localhost:8080 (or the next available port)

References

Project structure inspired by: https://blog.logrocket.com/building-vue-3-component-library/

About

Set of FlowForge-themed VueJS components that can be used in any FlowForge web applications.

Resources

License

Stars

Watchers

Forks

Packages

No packages published