@riiid/santa-closet-web

中文文档
0.1.3发布于 2020/09/01Apache-2.0

UI Design Kit for Santa's products

原始使用文档
文档目录6 节
  1. Installation
  2. Usage
  3. foundation
  4. Example
  5. Deploy
  6. License

santa-closet-web

NPM

UI Design Kit for 🎅's products

Dependencies

  • React 에 의존성을 가집니다.

🚧👷 warning 👷🚧

  • foundation & component 추가 시 중복되는 명칭이 없도록 주의합니다. 👀

Installation

yarn add @riiid/santa-closet-web

Usage

foundation

santa-closet 의 색상, 아이콘, 쉐도우 스타일을 정의합니다.
기본 팔레트 색상 외에도 테마 색상 dark 또는 light 을 적용하실 수 있습니다.

foundation 구조는 아래와 같습니다.

PluginREADME
ALL@riiid/santa-closet-web
colors@riiid/santa-closet-web/colors
theme@riiid/santa-closet-web/theme
icons@riiid/santa-closet-web/icons
shadows@riiid/santa-closet-web/shadows

예시

import {white1, shadowDown1} from '@riiid/santa-closet-web'
import {dark as theme} from '@riiid/santa-closet-web/theme';
import {Arrow, Cart, Password} from '@riiid/santa-closet-web/icons'

class Example extends Component {
  render () {
    return (
      <div style={shadowDown1}>
        <Arrow/>
        <Cart width={30} height={30} fill={white1}/>
        <Password fill={theme.color1}/>
      </div>
    )
  }
}

icon list image

Example

Cheetsheet

cheat sheet - https://santa-closet.riiid.app

Example Project

yarn link 로 deploy 된 /lib 폴더와 연결하여 테스트합니다.🖐🏻

Deploy

yarn release 스크립트 실행 후 배포되는 폴더의 버전과 루트 폴더의 버전을 동일하게 올려줍니다.

License

Riiid © Riiid

版本与发布记录

@riiid/santa-closet-web 共发布 17 个版本,首次发布于 2019/04/09;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.1.3latest2020/09/016 年前
0.1.22020/04/296 年前
0.1.12020/04/296 年前
0.1.02020/03/236 年前
0.0.122019/05/287 年前
0.0.112019/05/197 年前

关于 @riiid/santa-closet-web 的常见问题

@riiid/santa-closet-web 是什么?

圣诞老人产品UI设计工具包

如何安装 @riiid/santa-closet-web?

在项目目录运行 npm install @riiid/santa-closet-web,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(^15.0.0 || ^16.0.0)、react-dom(^15.0.0 || ^16.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@riiid/santa-closet-web 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/riiid__santa-closet-web 是否存在。

@riiid/santa-closet-web 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=8。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@riiid/santa-closet-web 可以商用吗?

@riiid/santa-closet-web 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@riiid/santa-closet-web 还在维护吗?

最新版本 0.1.3 发布于 2020/09/01(6 年前);至今共发布 17 个版本,其中过去 12 个月发布了 0 个;首次发布于 2019/04/09。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。