lenards / elm-ui-patternfly

An exploration of defining Pattern Fly design in elm-ui
BSD 3-Clause "New" or "Revised" License
7 stars 2 forks source link

PF4

About

This is an exploration of the PatternFly design system in elm-ui.

PatternFly Components

Built with elm-ui and the Builder Pattern.

Installation

elm install lenards/elm-ui-patternfly

:memo: - thanks for you interest; please note this is a package in early developement.

Status

This is a singular effort without official support. Though the version of this package is >1.0.0, this is a very "alpha" offering at this time. Your patience & interest are appreciated. If you have ideas, feedback, or overall comments, please consider filing an issue

Documentation is in a nascent and incomplete form - my advance & abject apologies.

Materials

As the exploration "sets out", the following materials have been "of use."

Thank you to their creators :bow:

Links:

Book(s):

Bonus:

Developing

Guidance on contributing will be forthcoming by mid-September 2021. It will be heavily inspired by the CONTRIBUTING.md provided in Ian Mackenzie's elm-geometry package.

Examples

Given how far down in the README this appears - I hope you might understand that the "Examples" are not in a particularly "robust" form at this time.

This repository recently shifted from being a "kicking the trees" endeavor to an actual package (or library). In doing that, I'm trying to find ways of demonstrating the PF4 components in a way to see if they're usage, helpful, and fit their intended purpose. It's in the middle of becoming a library with an Elm Book sample application.

There is a "lofi" example that will morph into "A PF4 Guide in PF4" (or, a PF4 implementation design guide on the PF4 components) and the beginnings of an ElmBook. Of the two examples, the ElmBook one has the least effort invested at the moment.

Each example started as Create Elm App. Though they are (currently) elm reactor compatible, I am developing them using elm-app commands. As PF4 components are more "flesh out", there will be Ellie examples since I think that's is likely a better manner for getting feedback about them.

You can find the default information provided by Create Elm App in the Examples below.