React-Component

This library aims to provide useful semantic colorsets, HOCs, and components for easy layout building. Check out our storybook!

Install

This library requires React and Emotion as peer dependencies. Install these packages before using this library.

"@emotion/react": "^11.7.1",
"@emotion/styled": "^11.6.0",
"react": "^18.2.0"

yarn add react @emotion/react @emotion/styled
yarn add @wookiejin/react-component

ResetStyle

The library provides a stylesheet for resetting browser-specific styling. Use <Gloabl/> from @emotion to import the stylesheet to your app.

import{Global}from'@emotion/react'import{ResetStyle}from'@wookiejin/react-component'functionApp(){return(<><Globalstyles={ResetStyle}/>
...
</>)}

View

The library provides a higher-order component View for layout building. You can wrap your custom component with View to inherit parameters for margins. You should pass the remaining props to the outermost component.

import{View}from'@wookiejin/react-component'interfaceProps{children: React.ReactNode}constCustomComponent=View<Props>(({ children, ...props})=>{return<div{...props}>{children}</div>})functionApp(){return(<div><CustomComponentmarginLeft={4}marginVertical={8}></div>
)
}

Components & Layouts

The components are styled by Emotion theme context API. You should wrap the components from this library with ThemeProvider from Emotion and inject a theme object predefined in this library.

import{ThemeProvider}from'@emotion/react'import{Fill,FillButton,DEFAULT_THEME}from'@wookiejin/react-component'functionApp(){constonClick=()=>{console.log('Clicked!')}return(<ThemeProvidertheme={DEFAULT_THEME}><HeaderTextmarginBottom={4}>Header<HeaderText><FillButtonfill="Secondary"onClick={onClick}>
Click Me
</FillButton></ThemeProvider>
)
}

Themes

The library provides a list of predefined themes. You can also define your theme. Refer to the theme files in /src/themes/ on the GitHub page.

import{css}from'@emotion/react'exportconstCUSTOM_THEME={font: {Title: css`font-size:2rem; `,SubTitle: css`font-size:1.3rem; `,SubSubTitle: css`font-size:1.1rem; `,Body: css`font-size:1rem; `,Caption: css`font-size:0.8rem; `,},
...
}

Typescript

If you use typescript, add the following type definition to access the theme type safely.

// emotion.d.tsimport'@emotion/react'import{DEFAULT_THEME}from'@wookiejin/react-component'declare module '@emotion/react'{exportinterfaceTheme{color: typeofDEFAULT_THEME.colorfont: typeofDEFAULT_THEME.fontborder: typeofDEFAULT_THEME.borderelevation: typeofDEFAULT_THEME.elevationfill: typeofDEFAULT_THEME.fill}}