wix-style-react

Common React UI components for all Wix verticals developing in React

Github星跟踪图



Dependencies
DevDependencies

? Install

npm install wix-style-react
yarn add wix-style-react

? Setup

If ?yoshi build runner is used for your application then all required loaders are already defined. If you'd rather set up your project manually, take a look at our webpack guide.

Minimal Yoshi version to be used with wix-style-react:

Version 4 - ^4.1.0

Version 3 - ^3.31.2

Load Wix fonts from CDN:

<link
  rel="stylesheet"
  href="//static.parastorage.com/services/third-party/fonts/Helvetica/fontFace.css"
/>

Enable font smoothing with browser specific css properties:

html {
  -webkit-font-smoothing: antialiased;
  -moz-osx-font-smoothing: grayscale;
}

Make sure that react and react-dom versions are not higher then:

  //package.json
 .
 .
 "react":"16.8.3",
 "react-dom":"16.8.3"
 .
 .
 

wix-style-react v6.x migration note:

If you're using wix-style-react 6.x and want to shift to 7.x version then read our migration guide.

Previous version documentation: https://wix-wix-style-react-v6.surge.sh/

? Usage

import { Button } from 'wix-style-react';

const App = () => (
  <Button>
    Click me!
  </Button>
);

? Testkits

All our components are provided with testkits that help our users test them.

A component testkit provides an interface to the component, enabling automated tests to access component functions without needing to know precise details of the technology being used.

//  Here is an example

// 1. import
import { inputTestkitFactory } from 'wix-style-react/dist/testkit';

// 2. initialize
const inputDriver = inputTestkitFactory({
  wrapper: document.body,
  dataHook: 'name-input',
});

// 3. interact
await inputDriver.enterText('hello world');

All methods are documented in our storybook components stories and some can be viewed through typescript interface.

Our testkits currently support four major testing frameworks: react-jsdom, protractor, puppeteer and selenium. Read our testing guidelines

⌨️ Typescript

The library is javascript based but types are supported with d.ts files. Not all components have types defined, but it is ongoing process to make it so.

Additional type interfaces are added in a separate repo called: wsr-types in order not to break our existing users. Read more on the repo description: https://github.com/wix/wix-ui/tree/master/packages/wsr-types

? Contributing PRs Welcome

We welcome contributions to Wix-Style-React!

Read our contributing guide and help us build or improve our components.

? License

This project is offered under MIT License.

主要指标

概览
名称与所有者wix/wix-style-react
主编程语言JavaScript
编程语言JavaScript (语言数: 7)
平台
许可证MIT License
所有者活动
创建于2016-11-14 14:37:00
推送于2021-04-28 14:22:28
最后一次提交2021-04-28 16:36:24
发布数2495
最新版本名称RC;.;1.2597.0 (发布于 2021-04-28 13:53:41)
第一版名称4.1.0 (发布于 2018-06-06 16:59:01)
用户参与
星数805
关注者数295
派生数209
提交数9k
已启用问题?
问题数1318
打开的问题数0
拉请求数4927
打开的拉请求数30
关闭的拉请求数803
项目设置
已启用Wiki?
已存档?
是复刻?
已锁定?
是镜像?
是私有?