Skip to content

README.md

Latest commit

 

History

History
45 lines (30 loc) · 1.37 KB

README.md

File metadata and controls

45 lines (30 loc) · 1.37 KB

NL-Design-System

This NL-Design-system repository is a customizable and straightforward component library to help make Progressive Web Applications faster, attractive, and more accessible with React.

The main benefits of working with a standardised, component library is being able to develop faster with pre-built components and compliance with the NL Design System as a whole.

Installation

NL-Design-System is available as an NPM package.

// with npm
$ npm install @conductionnl/nl-design-system

// with yarn
$ yarn add @conductionnl/nl-design-system

Usage

Here's a quick example to get you started, it's all you need

import  *  as  React  from  "react";
// Import the InfoTooltip Component
Import { InfoTooltip } from "@conductionnl/nl-design-system"

// Render the component in your app
const App = () => {
	render (
		<>
			InfoTooltip  content={<>Pass any JSX.Element here</>} placement={"bottom"} />
		</>
	)
}

Examples

Take a look at our NL Design Skeleton App and the Skeleton App repo. Additional components can be implemented like the code snippet above.

Roadmap

A more advanced documentation is to be released in the near future. More examples and Tutorials are coming up!