Giter Club home page Giter Club logo

smarthr-ui's Introduction

SmartHR UI

SmartHR は、SmartHR 基本機能からはじまり、今では多くのオプション機能を提供しています。 SmartHR UI はそのすべてのアプリケーションの UI コンポーネントを共通化して、開発生産性や完成度を向上させるための UI コンポーネントライブラリです。

npm version CircleCI e2e

コンポーネント

masterブランチのコンポーネント一覧は Storybook から確認できます。 https://story.smarthr-ui.dev

インストール

SmartHR-UI はnpm packageとして提供しています。

// with npm
npm install smarthr-ui

// with yarn
yarn add smarthr-ui

peerDependencies として React, React-DOM, styled-components が必要です。

// with npm
npm install react react-dom styled-components

// with yarn
yarn add react react-dom styled-components

使いかた

最もシンプルで簡単な使用例を紹介します。

import React from 'react'
import { createRoot } from 'react-dom/client'
import { createTheme, ThemeProvider, Button } from 'smarthr-ui'

const theme = createTheme()

const App: React.FC = () => (
  <ThemeProvider theme={theme}>
    <Button variant="primary">Hello World</Button>
  </ThemeProvider>
)

const container = document.getElementById('app')
const root = createRoot(container)
root.render(<App />)

コントリビュート

SmartHR UI は OSS です。コントリビュートをお待ちしています。

更新履歴

更新履歴はReleasesを確認してください。

デザイン・ロゴの利用について

  • SmartHR UI のデザインデータはFigmaで公開しています。
  • SmartHR のロゴを利用する場合はSmartHR Design Systemの利用規約を確認してください。

ライセンス

このプロダクトはMITの条件に従ってライセンスされています。

smarthr-ui's People

Contributors

renovate[bot] avatar nabeliwo avatar wmoai avatar dependabot-preview[bot] avatar im36-123 avatar uknmr avatar atsushim avatar ouji-miyahara avatar github-actions[bot] avatar cidermitaina avatar koba04 avatar tokky0425 avatar dependabot[bot] avatar masup9 avatar renovate-bot avatar kgsi avatar yamish123 avatar wacky avatar dependabot-support avatar yt-ymmt avatar kufu-guest avatar meganemura avatar diescake avatar versionfive avatar ykarakita avatar wmoai-shr avatar wata727 avatar taconasu avatar tacigar avatar yuw27b avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.