https://github.com/kwooshung/react-themes
A super convenient theme management component, you can set the theme color by yourself, add custom themes at will, and design templates by yourself. All data themes share the same state, support local storage settings, and can determine light or dark colors according to the system.
https://github.com/kwooshung/react-themes
component components dark light react theme
Last synced: 6 months ago
JSON representation
A super convenient theme management component, you can set the theme color by yourself, add custom themes at will, and design templates by yourself. All data themes share the same state, support local storage settings, and can determine light or dark colors according to the system.
- Host: GitHub
- URL: https://github.com/kwooshung/react-themes
- Owner: kwooshung
- License: mit
- Created: 2024-02-19T13:43:16.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-26T07:42:43.000Z (9 months ago)
- Last Synced: 2024-12-09T20:55:31.299Z (6 months ago)
- Topics: component, components, dark, light, react, theme
- Language: JavaScript
- Homepage:
- Size: 230 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: changelogs/.history
- License: LICENSE
Awesome Lists containing this project
README
# @kwooshung/react-themes
> A super convenient theme management component, you can set the theme color by yourself, add custom themes at will, and design templates by yourself. All data themes share the same state, support local storage settings, and can determine light or dark colors according to the system.
[](LICENSE)
[](https://www.npmjs.com/package/@kwooshung/react-themes)
[](https://www.npmjs.com/package/@kwooshung/react-themes)
[](https://github.com/kwooshung/React-Themes/actions/)
[](https://codecov.io/gh/kwooshung/React-Themes)
[](https://codeclimate.com/github/kwooshung/React-Themes/maintainability)
[](https://gitee.com/kwooshung/React-Themes/)
# Why Develop It?
- In today's world, can a website be called modern without a **`Change Theme`** feature? At the very least, it should have a **`Dark Mode`**, right?
# What Pain Points Does It Solve?
- Every time a website is developed, there's the hassle of writing a theme management system from scratch;
- Why not use other third-party components?
- They are often highly integrated with their own UI component libraries;
- The functionality is too complex and not lightweight enough;
- The lightweight component libraries, on the other hand, tend to be overly simplistic in features;
# Why Use It?
- **Headless**, no predefined styles, allows customizing the theme switch button or list;
- Supports custom theme colors, with default support for **'light'** and **'dark'** themes;
- Easy to use, simple operation, **low learning curve**, and high flexibility;
- Shared state, all data themes share the same status;
- Implemented with modern **ES6** features;
- Written in **TypeScript** for type safety;
- Modular **esm** import on demand, naturally supports **tree-shaking**, no worries about the size after packaging;
- Of course, this project also offers a **commonjs (cjs)** version;
- **100%** test coverage;
# Demo
- [CodePen](https://codepen.io/kwooshung/pen/vYPwypM)
- [CodeSandbox](https://codesandbox.io/p/devbox/react-themes-tmdtrh?file=%2Fsrc%2Fmain.tsx%3A9%2C3)
# Installation
## npm
```bash
npm install @kwooshung/react-themes
```
## yarn
```bash
yarn add @kwooshung/react-themes
```
## pnpm
```bash
pnpm add @kwooshung/react-themes
```
# Usage
# 使用方法
Components wrapped by `ThemesProvider` can access the unified theme state through `Themes`.
## ThemesProvider
```tsx
import { ThemesProvider } from '@kwooshung/react-themes';
import Switch from './Switch';
/**
* @zh 主题列表
* @en Theme list
*/
const ThemeList = ['light', 'dark', 'blue', 'green'];
/**
* @zh 全局布局
* @en Global layout
*/
const Layout = () => {
return (
{/* */}
{/* */}
);
};
export default Layout;
```
## useThemesContext
```tsx
import { useThemesContext } from '@kwooshung/react-themes';
const ThemeSwitcher = () => {
const { themeValue, themeName, setTheme, getAvailableThemes } = useThemesContext();
return (
Current Theme: {themeName}
{getAvailableThemes().map((theme) => (
- setTheme(theme)}>
{theme}
))}
);
};
export default ThemeSwitcher;
```
# API
Interface type definitions can also be found in the **[interfaces.d.ts](./src/themes/interfaces.d.ts)** source file.
## IThemesProviderProps
| Properties | Type | Default Value | Description |
| ------------ | -------- | --------------------------- | -------------------------------------------------------------------------------------- |
| defaultValue | string | `auto` | Default theme value |
| list | string[] | `['light', 'dark']` | List of themes |
| saveKey | string | - | Optional. Key used to save the theme in a cookie, if provided, the theme will be saved |
| saveExpired | number | `365 * 24 * 60 * 60 * 1000` | Optional. Cookie expiration time in milliseconds, defaults to one year |
## useThemesContext
`useThemesContext` is a Hook used to access the current theme context. It must be used within `ThemesProvider`.
```typescript
const { themeValue, themeName, setTheme, addTheme, getAvailableThemes } = useThemesContext(); // Returns an object of type `IThemesContext`
```
## IThemesContext
| Properties | Type | Default Value | Description |
| ------------------ | ----------------------- | ----------------- | ----------------------------------------------------------------------------------------------------------------- |
| themeValue | string | `auto` | 当前主题值，默认 `auto` |
| themeName | string | `auto` | 当前主题名，除了 `auto` 以外，和 `themeValue` 一样，如果 `themeValue = auto`，若系统是暗色调，则 `themeName=dark` |
| setTheme | (theme: string) => void | - | 设置当前主题 |
| addTheme | (themes: string | string[]) => void | 添加主题 |
| getAvailableThemes | () => string[] | - | 获取可用主题列表 |