@sinoui/switch

开关切换组件。UI 遵循 Material Design 设计规范。

官方文档

依赖安装

yarn add @sinoui/switch

简单示例

import Switch from '@sinoui/switch';

function Demo() {
  const [checked, setChecked] = useState(false);

  const handleChange = useCallback((event) => {
    setChecked(event.target.checked);
  }, []);

  return <Switch checked={checked} value="switch1" onChange={handleChange} />;
}

更多示例请参考官方文档。

本地开发

项目中有以下可用的命令。

yarn start

在开发和监听模式下启动项目。当代码发生变化时就会重新编译代码。它同时会实时地向你汇报项目中的代码错误。

yarn build

打包，并将打包文件放在dist文件夹中。使用 rollup 对代码做优化并打包成多种格式（Common JS，UMD和ES Module）。

yarn lint

yarn lint会检查整个项目是否有代码错误、风格错误。

开启 vscode 的 eslint、prettier 插件，在使用 vscode 编码时，就会自动修正风格错误、提示语法错误。

yarn format

yarn format可以自动调整整个项目的代码风格问题。

yarn test

yarn test以监听模式启动 jest，运行单元测试。

开启 vscode 的 jest 插件，会在文件变化时自动运行单元测试。

预览文档

yarn doc:dev

编译并打包文档

yarn doc:publish