Bubblegum Entity Access

Access to settings and states for widgets of the Bubblegum UI toolkit

Installing Elm packages

There is no dependency.

elm-app package install flarebyte/bubblegum-entity

Model

Attribute

An attribute represents a small piece of information such as a Semantic triple.

attrLabel =
     { id = Just "id:1234"
    , key = "ui:label"
    , facets = ["blue"]
    , values = ["Some label"]
    }  

Outcome

An outcome is a type which borrows concepts from both Elm Maybe and Result.

type Outcome value
    = Valid value
    | None
    | Warning String

Settings

A settings entity represents some configuration that is applied to a widget.

 {
     attributes = [
         attr "ui:label" "some label"
         , attr "ui:font" "Arial"
     ]
 }

State

A state entity is similar to settings but represents the live state that is applied to a widget.

 {
     attributes = [
         attr "ui:selection" "first item"
     ]
 }

Validation

List of validations that can be applied to an outcome.

For most validations:

• None will propagate as None.
• Warning will propagate as Warning.
• A failure to validate the outcome will produce a Warning.

Technical design

See Technical design

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

Managed automatically by Elm version rules.

Authors

• Olivier Huin - Initial work - olih

See also the list of contributors who participated in this project.

License

This project is licensed under the BSD 3-Clause License - see the LICENSE.md file for details