something-test v0.0.3
jarvis Atoms
jarvis is a framework-free open source UI toolkit. It provides great structure for building websites quickly with a scalable and maintainable foundation.
jarvis Atoms is a set of web components powered by jarvis CSS.
Ready to Code Dev Environment
Contribute to jarvis using a fully featured online development environment that will automatically: clone the repo, install the dependencies and start the webserver.
Local Developer Setup
First of all install NVM.
When that is complete run:
$ nvm use
$ npm i
$ npm startCommitting
When committing changes please follow the Conventional Commits format.
Installing the JavaScript Components
Link to it by adding the following to your <head></head>.
<script src="https://unpkg.com/@jarvis/atoms@x.x.x/dist/jarvis-atoms.js"></script>The x.x.x is the specific version of the library, you should use specifc versions to prevent against breaking changes.
That's it! Start using the components in your HTML.
Integrating with a Framework
jarvis uses Stencil to compile our components into Web Components. And since they can be used within frameworks or in standard HTML websites the best resource to read is the Stencil documentation regarding framework integration.
3 years ago