@sinoui/ripple
v1.0.13
Published
遵循 Material Design 的涟漪效果实现。
Downloads
2,908
Keywords
Readme
ripple
涟漪效果。遵循 Material Design States 规范。 文档
安装
yarn add @sinoui/ripple
使用
import { useRipple } from '@sinoui/ripple';
function Button({ disabled, ...rest }) {
const ref = useRipple({ disabled });
return <button ref={ref} disabled={disabled} {...rest} />;
}
本地开发
项目中有以下有用的命令。
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 release
发布库到 npm 中的命令:yarn release
。
预览文档
yarn doc:dev
编译并打包文档
yarn doc:publish
发布文档
yarn doc:publish