1.0.1 • Published 6 years ago

material-ui-feature-discovery-prompt v1.0.1

Weekly downloads
51
License
MIT
Repository
github
Last release
6 years ago

Material Feature Discovery Prompt

JavaScript Style Guide Build Status

Provide value and encourage return visits by introducing users to new features and functionality at contextually relevant moments.

Example

See this component in action

Installation

npm i --save material-ui-feature-discovery-prompt

Usage

import FeatureDiscoveryPrompt from 'material-ui-feature-discovery-prompt'

// ...
render() {
  return(
    <div>
      <Button onClick={() => setState({isOpen: true})}>Click me!</Button>
      <FeatureDiscoveryPrompt
        onClose={() => setState({isOpen: false})}
        open={state.isOpen}
        backgroundColor='rgb(0,150,136)'
        title="Title"
        description="Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor"
       >
          <Button
            color='secondary'
            variant='fab'
            onClick={() => setState({isOpen: false})}
          >
            <Add />
          </Button>
      </FeatureDiscoveryPrompt>
    </div>
  )
}

SearchBar Properties

NameTypeDefaultDescription
children*nodeThe node which will be featured.
open*boolDefines if the prompt is visible.
onClose*funcFired when the the prompt is visible and clicked.
styleobjectOverride the inline-styles of the root element.
titlestringDefines the title text.
descriptionstringDefines the description text.

* required property

License

The files included in this repository are licensed under the MIT license.