Skip to content

Latest commit

 

History

History
52 lines (40 loc) · 2.01 KB

README.md

File metadata and controls

52 lines (40 loc) · 2.01 KB
Raw

Wix Style React

wix-style-react is a collection of React components that conform to Wix Style created by Wix UX guild.

Demo | Source

Setup

  • Install with npm or yarn:
npm i wix-style-react
# OR
yarn add wix-style-react
  • Use in your project:
import React from 'react';
import Button from 'wix-style-react/Button';

const MyComponent = () =>
  <Button onClick={() => console.log('thanks for clicking :)')}>
    Click me!
  </Button>;

Tips & Tricks

  • wix-style-react works best when Haste is used as build tool. If you do not use it, read webpack setup instructions here;
  • Ensure <body> has either ltr or rtl class applied to it (depending on the displayed language);
  • To enable font smoothing, use browser specific css properties, for example: 
    html {
  -webkit-font-smoothing: antialiased;
  -moz-osx-font-smoothing: grayscale;
}
  • Make use of storybook demo page which includes all available components with interactive examples.

Tests

Please refer to the Testing page

Contributing

Please refer to the Contribution page

License

This project is offered under MIT License.