@castlewater/ui-components

React Components for CastleWater UI

Usage no npm install needed!

<script type="module">
  import castlewaterUiComponents from 'https://cdn.skypack.dev/@castlewater/ui-components';
</script>

README

React Components for CastleWater UI

Linting running automatically before committing your code. Only modified files are processed. All unit-tests running before pushing your code.

Avaliable components:

  • Accordion
  • BackToTop
  • Breadcrumbs
  • Button
  • Checkbox
  • Cookie-law
  • Cross
  • Datepicker
  • Dropdown
  • FloatingButtons
  • Input
  • Layout
  • Modal
  • Nav-bar
  • Notifications
  • ProgressBar
  • Slider
  • Spinner
  • Table
  • Toaster
  • Tooltip

General Usage

To use components, you should add "@castlewater/ui-components": "~1.0.0" to your "dependencies" in package.json or just npm install --save @castlewater/ui-components

To lock package version you need to specify it in package.json directly. "@castlewater/ui-components": "1.0.1"

Now you can import and use it into your code

import { Button, Table } from '@castlewater/ui-components'

<Button color='blue' size='s' label='login'>

Storybook

Use npm run dev to run storybook

Changelog

Contributing

Each time you change ui-components repository you should change varsion in package.json according to semantic versioning rules

After your pull reguest were merged it will trigger a Jenkins' job automatically to publish new package version to npmjs.com

Don't forget to update CHANGELOG.md