Skip to content
/ vibe Public

🎨 Official monday.com UI resources for application development in React.js

Notifications You must be signed in to change notification settings

mondaycom/vibe

Folders and files

NameName
Last commit message
Last commit date

Latest commit

author
Hadas Farhi
Jul 25, 2021
5efd77d Β· Jul 25, 2021
Oct 14, 2020
Jun 16, 2021
Nov 21, 2020
Mar 18, 2021
May 25, 2021
Jul 25, 2021
Oct 6, 2020
Apr 12, 2021
May 2, 2021
Oct 6, 2020
Oct 6, 2020
Dec 28, 2020
Oct 7, 2020
Oct 11, 2020
Oct 6, 2020
Oct 6, 2020
Apr 29, 2021
Nov 21, 2020
Oct 6, 2020
Dec 29, 2020
Mar 15, 2021
Dec 29, 2020
Jul 12, 2021
Jul 25, 2021
Oct 15, 2020
Mar 24, 2021

Repository files navigation

Monday UI React Core

monday.com React components library - Storybook

Edge
IE / Edge
Firefox
Firefox
Chrome
Chrome
Safari
Safari
iOS Safari
iOS Safari
Samsung
Samsung
Opera
Opera
18+ last 4 versions last 4 versions 12.1+ last 2 versions last 2 versions last 2 versions

Installation

Install the component library

$ npm install monday-ui-react-core

Usage

You can either import { Button } from "monday-ui-react-core"; or you might want to import directly the component import Button from "monday-ui-react-core/dist/Button";

You also need to import Main CSS file to your project import "monday-ui-react-core/dist/main.css"

Storybook

We are using storybook in order to develop the components independently from any consumer. run this to build & run the storybook locally:

npm run storybook

the storybook will hosted on http://localhost:7007

Developing locally with your consumer application

When developing locally we are using a npm functionality called npm link, this allows us to work locally on our package and use it in a different project without publishing. This functionality basically overrides the npm mapping between package name to its repo, and points it to where the package is located locally.

Troubleshooting local development

  • If you are using NVM, make sure both packages are using the same version.
  • Because we are using react hooks and having react as a peerDependency - if you want to develop locally and encounter issues with "invalid hook call" See this github thread. The quick fix is in your webpack config file alias react to resolve the node_modules path

go to the project's directory and run:

nvm use
npm unlink
npm link
npm start

Contributing

We welcome every contributor, please read the contribution guidelines before submitting a PR

Themes

We support theming from the library to the component level using css variables - for more info on theming please read the theme guidelines file

Release

Perform the following steps to release a new version: