Lumi.Components

type LumiProps props = { className :: String, css :: LumiTheme -> Style | props }

type PropsModifier props = (LumiProps props -> LumiProps props) -> (LumiProps props -> LumiProps props)

propsModifier :: forall props. (LumiProps props -> LumiProps props) -> PropsModifier props

Lift a props -> props function for composition with other PropsModifier functions.

newtype LumiComponent props

Constructors

• LumiComponent { className :: String, component :: ReactComponent (LumiProps props), defaults :: Record props, name :: String }

lumiComponent :: forall props hooks. Lacks "children" props => Lacks "key" props => Lacks "ref" props => String -> Record props -> (LumiProps props -> Render Unit hooks JSX) -> Effect (LumiComponent props)

Create a LumiComponent from a name, set of defaults, and a render function. The render function behaves the same as in the hooks API.

lumiElement :: forall props. LumiComponent props -> (LumiProps props -> LumiProps props) -> JSX

Render a LumiComponent. Similar to React.Basic.element, except the second argument is an update function rather than a plain record for props. This helps reduce the surface area for API updates:

React.Basic.element reactComponent
  { relevantProp, otherProp1: mempty, otherProp2: mempty, ...etc }

-- vs

lumiElement lumiComponent _{ relevantProp = relevantProp }