https://github.com/oma-wc/oma
a framework independent web components library
https://github.com/oma-wc/oma
component-library hacktoberfest haunted lit-html web-components
Last synced: 2 months ago
JSON representation
a framework independent web components library
- Host: GitHub
- URL: https://github.com/oma-wc/oma
- Owner: oma-wc
- License: other
- Created: 2019-11-21T08:11:21.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-09-19T12:47:51.000Z (9 months ago)
- Last Synced: 2025-03-24T01:31:03.941Z (3 months ago)
- Topics: component-library, hacktoberfest, haunted, lit-html, web-components
- Language: JavaScript
- Homepage:
- Size: 1.99 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# oma
Qenya
**oma**
_noun_. everywhere
oma is a framework independent web components library.
[](https://lerna.js.org/)
## Install and use
See `components/` for available components.
See each components documentation for details on properties and styling.
[asdf](https://asdf-vm.com) is used as runtime dependency manager.
### Using a javascript build tool
Install: `yarn add @oma-wc/button`
Add to main javascript file: `import '@oma-wc/button'`
Use in HTML or JSX: `A simple button`
### Using a `` tag
Add to main HTML file:
`<script src="https://unpkg.com/@oma-wc/button" type="text/javascript">`
And then use it in HTML: `A simple button`
# Layout components
Requires due to style dependancies.
# Content components
Doesn't require , self contained style.
# Development
This is a multi package repo managed with [Lerna](https://lerna.js.org).
## Adding new components
Run `yarn bootstrap` to setup internal dependencies.
## Testing components
There's a very simple test page located in `components/index.html` which you can
run with `yarn dev:server`.
Build components automatically with `yarn watch`, for instance `yarn watch @oma-wc/menu`.
The watcher just forwards arguments to the build script.
## Publishing
- `yarn build`
- Commit
- Run `yarn lerna:publish` (you need authentication to NPM (`npm adduser`))