https://github.com/purescript-react/purescript-lumi-components
Library of our UI components
https://github.com/purescript-react/purescript-lumi-components
Last synced: 2 months ago
JSON representation
Library of our UI components
- Host: GitHub
- URL: https://github.com/purescript-react/purescript-lumi-components
- Owner: purescript-react
- License: apache-2.0
- Created: 2019-03-12T16:50:27.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2024-03-11T09:51:30.000Z (about 2 years ago)
- Last Synced: 2026-01-29T04:47:09.201Z (3 months ago)
- Language: PureScript
- Homepage: https://lumihq.github.io/purescript-lumi-components/#/
- Size: 10 MB
- Stars: 104
- Watchers: 10
- Forks: 5
- Open Issues: 49
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Roadmap: ROADMAP.md
Awesome Lists containing this project
README
# purescript-lumi-components [](https://travis-ci.org/lumihq/purescript-lumi-components)
- [lumihq.github.io/purescript-lumi-components](https://lumihq.github.io/purescript-lumi-components/)
- [purescript-lumi-components on Pursuit](https://pursuit.purescript.org/packages/purescript-lumi-components/)
This is a component library focused on Lumi's specific UI and UX needs. Available components are found in `src/components`.
## Goals and Roadmap
See [ROADMAP.md](ROADMAP.md) for more info.
## Installation
```sh
bower i -S purescript-lumi-components
```
To use the styles that come with these components the CSS needs to be injected into the page. The easiest way to do this is to run the `attachGlobalComponentStyles` effect available in `Lumi.Components.Styles` one time as your application initializes.
You will also need a few `npm` dependencies. These dependencies and their versions must be compatible with the ones listed [here](https://github.com/lumihq/purescript-lumi-components/blob/master/package.json#L31).
## Local development
```sh
npm i; npx bower i; npx pulp build
npm start
```
You can run production builds (output minified, static files to `build/`) using `npm run build`.
## Tagging a new release
```sh
pulp version 0.x.y
pulp publish
npm run deploy
```
_Don't use `npm version`!_
## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md) for more info.