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

@superys/momo-ui

v1.0.4

Published

A design system that works as a comic relief. It's light and fun

Downloads

13

Readme

Momo UI - Design System

Momo UI logo

The Comic relief design system for React.js projects.

Our goal is to create a design system that is lightweight for the user and contrasts with the stress situations they may be experiencing. As a result we want them to have a fun and quiet experience 😌

Check it out

We use Storybook to document and review the development of our design system. There you will find what components do we have, how they look, and what code you should use to implement them.

See our storybook

Use it in your app

Momo UI components are developed with React.js using styled-components. To set general styles and use it in your own React project, follow these instructions:

  1. Install the npm momo-ui package in your project
yarn add @superys/momo-ui

or

npm i @superys/momo-ui
  1. Load fonts and icons (phosphor icons) in your public/index.html head tag
<head>
  ...

  <!-- Load Google fonts -->
  <link rel="preconnect" href="https://fonts.googleapis.com" />
  <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
  <link
    href="https://fonts.googleapis.com/css2?family=Fredoka+One&family=Nunito+Sans:wght@300;400;600;700&family=Quicksand:wght@400;700&display=swap"
    rel="stylesheet"
  />

  <!-- Load Phosphor icons -->
  <script src="https://unpkg.com/phosphor-icons"></script>
</head>
  1. Wrap everything with MomoStyleWrapper before your app is mounted (probably src/index.jsx)
...
import { MomoStyleWrapper } from "@superys/momo-ui";
...

ReactDOM.render(
  <React.StrictMode>
    <MomoStyleWrapper>
      <App />
    </MomoStyleWrapper>
  </React.StrictMode>,
  document.getElementById("root")
);
  1. Use the components in your app! Check our storybook to see the available components and how to sue them.
import { Button } from "@superys/momo-ui";

function App() {
  return (
    <div>
      ...
      <Button>You got it!</Button>
    </div>
  );
}
  1. (Optional) Use the utils variables (colors, type scales, fonts, etc) in case you need them!
import styled from 'styled-components';
import { yellow } from '@superys/momo-ui';

const WarningBox = styled.div`
  border: 2px solid ${yellow[300]};
  background-color: ${yellow[200]};
`

Create a custom theme

We know you love our colors and style! But we also know you might need to tweak them sometimes to match your brand. You can do it by creating a custom theme, based on our defaultTheme and passing it to the MomoStyleWrapper.

...
import { MomoStyleWrapper, defaultTheme, neutral } from "@superys/momo-ui";
...

const pink = { [300]: "#EF6AC3", [400]: "#EF6AC3" };

const customTheme = {
  ...defaultTheme,
  palettes: { ...defaultTheme.palettes, pink },
  primary: { main: pink[400], hover: pink[300], contrast: neutral[100] },
};

ReactDOM.render(
  <React.StrictMode>
    <MomoStyleWrapper theme={customTheme}>
      <App />
    </MomoStyleWrapper>
  </React.StrictMode>,
  document.getElementById("root")
);

You're ready to go. To know more about momo-ui components, please check our storybook where you will find everything you need to use our components.

Get involved

We're still working hard to make momo-ui grow and be available for anyone. If you'd like to contribute designing or coding, please get in touch! [email protected]

  • Find ways to contribute [contribution docs in progress ...]
  • Prep to commit code [code-contribution docs in progress ...]

Run Storybook locally

Install nvm

nvm install
nvm use

Install dependencies and Run the storybook in localhost:6006

yarn
yarn storybook

Usage License

The idea is that anyone can use this design system in their projects, as long as the result source code is open to the public. We use the GNU GENERAL PUBLIC LICENSE Version 3.