npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@mj-studio/react-design-toolkit

v1.4.1

Published

A React Design Toolkit top of the chakra ui

Downloads

329

Readme

MJStudio React Design Toolkit

ogimage-1260-630

An opinioned design system toolkit tailored for React applications using Next.js

This package is top of the Chakra UI, incorporating related libraries internally.

The all libraries are dependency of chakra-ui itself.

You should install peer dependencies for it works correctly.

Install

yarn add @mj-studio/react-design-toolkit

Install Peer Dependencies

"@chakra-ui/next-js": "^2.2.0",
"@chakra-ui/react": "^2.8.1",
"@emotion/react": "^11.11.3",
"@emotion/styled": "^11.11.0",
"framer-motion": "^11.0.8",
"styled-components": "^6.1.8",
"styled-system": "^5.1.5"

Usage

1. Create theme file

AppTheme.ts

'use client';  
  
import { extendBaseTheme } from '@mj-studio/react-design-toolkit';  
  
export default extendBaseTheme({});

Extend & Extend Theme token is described as the following section.

2. Wrap with DesignProvider

app/layout.tsx

<DesignProvider initialColorMode={'dark' /* or light */ } theme={AppTheme}>
  {children}
</DesignProvider>

You should this in React Server Component.

Pass theme object created by Step 1 to theme prop.

3. Use Component, Hook, Theme Token

All components are wrapping of Chakra-UI components.

So you can use all the styled-system syntax used in it.

Currently, css variables always have a prefix of --ck, this can be changed by chakra-ui css-var-prefix config feature.

For example, colors can be used in CSS like var(--ck-colors-red-500).

Here is an example.

export default function Page() {  
  return (  
    <Column>  
      <Card colorScheme={'red'} mt={2} bg={'background'} />  
      <Txt color={'red50.50'}>{'123'}</Txt>  
    </Column>  
  );  
}

Change & Extend Theme Token

If you want to extend base theme, you can use extendTheme like syntax to define properties.

The properties of theme Dict are same as Chakra-UI Itself.

You can learn more about in Chakra-UI Docs

Change & Extend base theme tokens

A list of all theme tokens can be found in node_modules/@chakra-ui/styled-system/dist/theming.types.d.ts by executing the following Type Generation command after installing the package.

// yarn
yarn theme lib/AppTheme.ts

// npm
npm run theme lib/AppTheme.ts

In your Theme file,

'use client';  
  
import { extendBaseTheme } from '@mj-studio/react-design-toolkit';  
  
export default extendBaseTheme({  
  semanticTokens: {  
    colors: {  
      background: {  
        default: 'red',  
        _dark: 'blue',  
      },  
    },  
  },  
});

You can also utilize the charka-ui method of creating custom themes from objects exported as themes.

For detailed instructions, please refer to the following. docs

Components

  • TBD

Hooks

  • TBD

TypeScript & CLI

If you want to use Typescript, run this command from your project root.

// yarn
yarn theme lib/AppTheme.ts

// npm
npm run theme lib/AppTheme.ts

It will generate theme type definition file to node_modules/@chakra-ui/styled-system/dist/theming.types.d.ts by your theme file configuration.

TypeScript will recommend tokens from the theme as much as possible, but this does not guarantee complete type safety.

Basically, properties must also be able to accept values that can be expressed in CSS, so if you insert a non-existent theme token value, the feature will not work properly.

Troubleshooting

This package is on alpha phase.

Any issue filing is welcome 🤗