Malty Component Library

Malty is a Design System, and the code contained in this repository is its Component Library.

Notes to keep in mind:

• You don't have to clone this repo in order to use Malty, and this Component Library.
• Development of components for this library must be in close coordination with Malty's Maintainers, and should only happen after previous coordination in Malty's GitHub Discussions or an issue has been created and approved to move forward.
• This repository should be considered our file system, and the means by which we manage contributions and maintainance of components in Malty Carlsberg Group's.

Getting Started

This project uses Lerna to manage the monorepo packages and GitHub Packages to publish each component.

Install

Clone the repo

git clone https://github.com/carlsberg/malty

Install packages

yarn install

Build packages

yarn build

Run storybook local env.

To start your local dev. server:

yarn start

To build Storybook static files:

yarn build-storybook

Testing

To run tests on your local code:

yarn test

Alternatively you can add the --watch flag for continued refresh and testing, as well as the -u flag to update your snapshots, when relevant and needed.

Usage

import React from 'react';
import { Component, ComponentProps } from '@carlsberg/malty.atoms.component';

export const component = ({ children }: ComponentProps) => {
  const renderComponent = () => <Component>{childen}</Component>;
};