Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

parvus-ui

2.0.3 • Public • Published

parvus-ui

npm GitHub issues

Welcome to Parvus-UI!

This library is a small footprint shareable UI component library for React and Preact.

The origin of this is seeing how big component libraries had become. They had loads of really great features and they looked great, but they were huge and this made me sad. So I set about to create something with loads of useful features, without going overboard, but in a really small footprint.

Features:

  • Over 15 component types that are often found in every app (buttons, cards, links, breadcrumbs, modals...).
  • Theme provider with contaxt API polyfill for Preact and React 15.
  • styles and className props to customise every component
  • A dev component and styleguide to view and try out every component.
  • Less than 5 KB.

Check out our styleguide: parvusui.github.io View an example project: github.com/parvusui/parvus-ui-example

Installation

$ npm install parvus-ui --save

Usage

Theming

The context api is used for theming and we even have included a polyfill for preact and older versions of react.

To get started on theming just add the provider to your entry or app js file and provide it with the theme like below:

<ThemeProvider
  theme={{
    backgroundColor: '#fefefe',
    neutralColor: '#f9f9f9',
    primaryColor: '#007bff',
    secondaryColor: '#6c757d',
    tertiaryColor: '#fefefe',
    successColor: '#3cb371',
    errorColor: '#ff0000',
    warningColor: '#ffa500',
    borderRadius: 0,
    fontColor: '#000000',
    fontFamily: 'Helvetica Neue, Helvetica, Arial, sans-serif'
  }}
>
  App code here
</ThemeProvider>

Components

All the components follow a similar pattern, just check out the props it requires first and get importing.

  <Button type="primary">Click</Button>

Styling

cxs is used for styling all components and each expose a styles prop which can both overwrite existing styles and also add styles:

<Button
  type="primary"
  styles={{
    backgroundColor: '#222222',
    ':hover': {
      backgroundColor: '#444444',
      opacity: 1
    }
  }}
>
  Click
</Button>

Accessibility

Everything you need for great accessibility support is included out of the box and, in fact, the examples page gets a 100 accessibility score on lighthouse.

Preact

This library works with preact by using preact-compat which you can find here.

Development

Help would be really great as there's so much to do. To get started:

  • Check our issues or get started on your great idea.
  • Fork the repo.
  • Follow the commands below.
  • When finished submit your pull request and let us have a look.

Guidelines

  • All components should be stateless functional components, although if there's a case otherwise please submit the pr anyway.
  • All components should have tests.
  • All components should be added to the examples view and styleguide.
  • Use rem in every component.

Commands

Install dependencies:

$ npm install

Run the example app at http://localhost:3000:

$ npm start

View the styleguide at http://localhost:6060:

$ npm run styleguide

Run tests and watch for code changes using jest:

$ npm test

Lint src and test files:

$ npm run lint

Questions

Docs never cover everything so if you've any questions feel free to reach out to @sringland on twitter or put it in a github issue.

License

MIT

Install

npm i parvus-ui

DownloadsWeekly Downloads

4

Version

2.0.3

License

MIT

Unpacked Size

158 kB

Total Files

110

Last publish

Collaborators

  • avatar