Leverege Platform

Leverege Platform

  • Overview
  • JSDocs
  • REST API
  • Help

›JSDoc

JSDoc

  • Home
  • API Server
  • API Attributes
  • Api Patch Ops
  • API Redux
  • Array Util
  • Base62 Util
  • Cache
  • Cluster Manager
  • Data Store
  • Exit
  • Factory
  • Limit
  • Lock
  • Message Queue
  • Messages
  • Path
  • Permissions
  • Reasoner
  • String Util
  • UI Active Theme
  • UI Elements
  • UI Linear View Elements
  • UI Mapbox Elements
  • Validator

UI Active Theme

Functions

props(component, variant) ⇒ object

Returns any default props for the supplied Component and Variant. If the third argument is an object, it will be overlaid on top of the component's default props and the component's variant props.

If the second argument is an object, it is considered to be the React component's actual props object, and the variant is looked up from it. This means from render, you can invoke: const { markClass } = theme.props( 'Checkbox', this.props )

props(component, variant) ⇒ object

Returns any default props for the supplied Component and Variant. If the third argument is an object, it will be overlaid on top of the component's default props and the component's variant props.

If the second argument is an object, it is considered to be the React component's actual props object, and the variant is looked up from it. This means from render, you can invoke: const { markClass } = theme.props( 'Checkbox', this.props )

variantClassNames(component, classes, type, variant)

Turns the variant's hierarchy into a hashified set of classnames.

onAppearanceLoaded()

Invoked on the initial download of the firebase appearance

styleToCss()

Turn component.style into cssText

extractStyleSheet()

Walk the style model to extract css. Form is [ { selector, value } | { type : 'conditional', selector, rules [ ] }]

objToCss()

Turn each key/value in obj into a css attribute

props(component, variant) ⇒ object

Returns any default props for the supplied Component and Variant. If the third argument is an object, it will be overlaid on top of the component's default props and the component's variant props.

If the second argument is an object, it is considered to be the React component's actual props object, and the variant is looked up from it. This means from render, you can invoke: const { markClass } = theme.props( 'Checkbox', this.props )

Kind: global function
Returns: object - an object containing the default props. This will be a merger of the default variant's props and the specified variants props. This will always return an object

ParamTypeDescription
componentstringthe name of the component type. eg "Button"
variantstring \objectthe variant name to requsest. eg "small"

props(component, variant) ⇒ object

Returns any default props for the supplied Component and Variant. If the third argument is an object, it will be overlaid on top of the component's default props and the component's variant props.

If the second argument is an object, it is considered to be the React component's actual props object, and the variant is looked up from it. This means from render, you can invoke: const { markClass } = theme.props( 'Checkbox', this.props )

Kind: global function
Returns: object - an object containing the default props. This will be a merger of the default variant's props and the specified variants props. This will always return an object

ParamTypeDescription
componentstringthe name of the component type. eg "Button"
variantstring \objectthe variant name to requsest. eg "small"

variantClassNames(component, classes, type, variant)

Turns the variant's hierarchy into a hashified set of classnames.

Kind: global function

ParamTypeDescription
componentobjectthe redux model for the component type
classesobjectthe jss classname lookup
typestringthe component type
variantstringthe component variant

onAppearanceLoaded()

Invoked on the initial download of the firebase appearance

Kind: global function

styleToCss()

Turn component.style into cssText

Kind: global function

extractStyleSheet()

Walk the style model to extract css. Form is [ { selector, value } | { type : 'conditional', selector, rules [ ] }]

Kind: global function

objToCss()

Turn each key/value in obj into a css attribute

Kind: global function

← String UtilUI Elements →
  • Functions
  • props(component, variant) ⇒ object
  • props(component, variant) ⇒ object
  • variantClassNames(component, classes, type, variant)
  • onAppearanceLoaded()
  • styleToCss()
  • extractStyleSheet()
  • objToCss()
Leverege Platform
Docs
Overview
Connect
FacebookLinkedInTwitter
Facebook Open Source