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

@storyblok/mui

v0.2.0

Published

A Storyblok MUI theme with reusable components.

Downloads

2,788

Readme

Node.js Package

@storybook/mui is a component library based on MUI. It is the ideal package to use for building Storyblok extensions with React as it takes care of the task of styling your components and lets you focus on building business logic. Thus, extensions built with @storybook/mui will seamlessly, visually integrate into Storyblok.

Find the full documentation for this package here.

What is MUI?

From mui.com:

MUI is an open-source React component library that implements Google's Material Design.

It includes a comprehensive collection of prebuilt components that are ready for use in production right out of the box.

What is included in this package?

@storybook/mui consists of a MUI theme that styles the MUI standard components according to Storyblok's design system. Since @storybook/mui is based on MUI, all the MUI standard components are available. Some of these components are visualised in the MUI Components section.

@storybook/mui also provides some additional components that are unique to this package. For example, the <AppLayout /> component is great for building custom application extensions. The documentation for all these components is located here.

Getting Started

The steps below explains how to include @storyblok/mui in your project.

Prerequisites

First of all, set up MUI with the help of MUI's official documentation.

With npm:

npm install @mui/material @emotion/react @emotion/styled

With yarn:

yarn add @mui/material @emotion/react @emotion/styled

Installation

Install @storyblok/mui:

npm install --save-exact @storyblok/mui

With yarn:

yarn add --exact @storyblok/mui

Wrap your application within a <ThemeProvider /> component:

import { lightTheme } from '@storyblok/mui'
import {
  CssBaseline,
  Button,
  ThemeProvider
} from "@mui/material";

const App = () => (
    <ThemeProvider theme={lightTheme}>
      <CssBaseline />
      <Button>
        Hello
      </Button>
    </ThemeProvider>
)