anrom-jive-osapi-picker

UI for place/people/content Jive JS API picker, for use in custom view tiles

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
10Nov 10, 2017Oct 28, 2016Minified + gzip package size for anrom-jive-osapi-picker in KB

Readme

anrom-jive-osapi-picker

Requirements

  • osapi global variable have to be exported as 'jive/osapi' in webpack externals
  • webpack should be configured to proces CSS files with style-loader!css-loader rule

Installation

npm

npm install -S anrom-jive-osapi-picker

Usage

Usage example:

import React from 'react'
import JivePicker from 'anrom-jive-osapi-picker'

export default function Picker({author, setAuthor}){
    return <JivePicker
        buttonTitle="Добавить блог"
        contentType="people"
        value={author}
        onChange={person => setAuthor({author: person})}
    />
}

Example of use with array as value

import React from 'react'
import JivePicker from 'anrom-jive-osapi-picker'

export default function Picker({placesArray, setPlaces}){
    return <JivePicker
        value={placesArray}
        // function receives the whole new array, not a single item
        onChange={places => setPlaces({placesArray: places})}
    />
}

API

Component propperties

property type default description
buttonTitle string "Add place" Sets the add button title
contentType string "place" Possible options: "people", "content"
Defines the type of content that the picker will be handling.
value object/array - Current place/person/content item or the array of specified type.
If array given the selector will allow multiple values
onChange function - arguments: selected item (object).
Fires when the selection of an object is performed

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.