@sergiogc9/react-ui-theme v1.3.0

React UI Theme

This package exports the necessary theme to work with my React UI library based on a design system using React, styled-components, styled-system and more.

See more info about the library HERE.

ℹ️ The library is still in a beta stage as I am still migrating many components here.

ℹ️ This library has been implemented by me and for me, hence it is highly opinionated.

Usage

Installation

Install the package from npm or github packages:

yarn add -S @sergiogc9/react-ui-theme

Add the provider to your app, customizing the theme if wanted and using reset config provided by the theme:

import { createGlobalStyle } from 'styled-components';
import theme, { ReactUIProvider } from '@sergiogc9/react-ui-theme';

const GlobalStyle = createGlobalStyle`
	${reset}
	// add other custom global styles here
`;

const App = () => {
   const finalTheme = merge(theme, {...}); // Customize theme if wanted

   return (
      <ReactUIProvider theme={finalTheme}>
	  	<GlobalStyle />
        {...}
      </ReactUIProvider>
   )
}

Documentation

This package basically exports the theme, its types and some helper functions. The theme is exported by default as seen in the example above.

The exported items are:

• theme (default export): The theme itself. It should be passed to the styled-components provider.
• Theme: The Theme typescript typing.
• reset: A set of common CSS rules to be used globally in the app if wanted. It should be used together with createGlobalStyle provided by styled-components.
• getColorFromTheme and getColorFromThemeWithOpacity: Returns the color value defined in the theme. Using directly the color values using styled-system approach is preferred.
• getColorByMode: Returns the specified color depending the current mode enabled.
• useChangeThemeMode: Custom hook to easily change the theme mode.