Code Monkey home page Code Monkey logo

patternfly-ds's Introduction

Patternfly design system

Patternfly-ds is a package that describes components from Patternfly, so that a design tool like Hadron can use it to provide a design experience with its components.

All credits go to Patternfly, i just made it usable as design system in Hadron.

Installation

Add patternfly-ds as a dependency to your project

npm install patternfly-ds

Converting components with variants from Patternfly docs

Of course not everything was done by hand, i created a small script to automatically generate the design systems json files and take screenshots of the example elements. The way Patternfly is documented is wonderful by itself but also extremely convenient for extracting component variants

To run the script yourself execute the following commands.

Requirements

# Clone patternfly repo inside project (so "./patternfly" is created)
git clone https://github.com/patternfly/patternfly.git

# install dependencies (seperate npm project, might be transfered to own repo in the future)
cd convert
npm install

# build and startup patternfly docs locally
npm run build
npm run start:patternfly

# start converting
npm start

# to clean up the files after conversion
npm run prettier

# if you want to check if the files are exported correctly
npm run lint

Contributing

Requests are welcome. Especially when using the convert script for another project, we might be able to make it universal and move it to a repo of it's own. Please open an issue first to discuss what you would like to change.

Missing/Todo

  • Tokens
  • Layouts & Utilities
  • Test various components

License

MIT

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.