ghost-design-system

Ghost Design System - React Components library

Demo

Available components:

• Atoms:
  • Badge (notification and indicator)
  • Colors
  • Icons
  • Layout
    • Row
    • Col
    • Collapsable section
  • Link
  • Modal
  • Portal
  • Pulsar
  • Tooltip
  • Typography
    • Text
    • Title
• Molecules:
  • Amount field
  • Button
  • Checkbox field
  • Datepicker field
  • File field
  • Percentage field
  • Popover
  • Rich Text field
  • Select field:
    • Single
    • Multi
    • Autocomplete (aka Dynamic Search)
    • Autocomplete creatable (aka Dynamic Search Creatable)
  • Switch field
  • Textarea field
  • Text field
  • YearPicker field
• Organisms:
  • ActionBar
  • Datatable:
    • Editable Data Table (full editable)
    • Line editable Data Table (editon in popup form with data validation)
    • Line editable in place data table (edition of a line in place)
    • Static data table
  • Filter
  • Form:
    • Form component
    • useForm hook
  • NavBar
  • SideBar

Usage

1. Run the command:

npm install ghost-design-system

1. Define the set of colors by copying the file: ~ghost-design-system/dist/assets/_colors.scss)

// Neutral pallet
$chalk: rgb(228, 228, 228);
$charcoal: rgb(51, 51, 51);
$pebble: rgb(117, 117, 117);
$silver: rgb(196, 196, 196);
$smoke: rgb(248, 248, 248);
$white: rgb(255, 255, 255);

// Additional pallet
$scooter: rgb(38, 186, 212);
$buttercup: rgb(244, 174, 38);
$cerulean: rgb(1, 82, 129);
$cinnabar: rgb(232, 61, 71);
$fern: rgb(92, 184, 92);
$sky: rgb(16, 156, 241);
$tangerine: rgb(229, 114, 0);

$error: rgb(255, 52, 24);

$primary: $scooter;
$secondary: $pebble;
$tertiary: $charcoal;

$fontfamily: 'Montserrat', sans-serif;

1. Create your index.scss file:

@import 'colors.scss';
@import '~ghost-design-system/dist/assets/_global.scss';
@import '~ghost-design-system/dist/assets/_general.scss'; // Optional

1. Load the required icon set, for example in your index.tsx :

import { loadIcons } from 'ghost-design-system';

loadIcons();

1. You should be ready to use any of the components of the library.

---

References

This react components library uses the following:

• @fortawesome
• @szhsin/react-menu
• classnames
• color-alpha
• color-rgba
• date-fns
• lodash
• numeral
• react-datepicker
• react-number-format
• react-select
• suneditor
• tippyjs
• yup

Peer dependencies:

• react
• react-dom
• suneditor - for SCSS import
• tippyjs - for SCSS import

Dev dependencies:

• ESLint
• Jest
• Prettier
• Rollup
• SCSS
• Storybook
• Testing-library
• Typescript

---

To go further

Changelog

1.4.6 (2022-05-08)

Features

• Organisms/SideBar simplified interface using component instead of props
• Organisms documentation

Bug Fixes

• Atoms/AmountInput support value 0 as a valid value
• Organisms/ActionBar allow use of icon in action button
• Organisms/DataTable ensure only editable row are editable
• Organisms/Filter add scss prefix to container class