ldx-widgets
Version:
widgets
79 lines (58 loc) • 1.49 kB
Markdown
[<< Component Index](../README.md)
# SelectPvr `/src/components/select_pvr.coffee`
Select popover menu with sub-option capability
## Mixins: `animationMixin`
## Props
### options
**`Array`**
_Required_
array of objects containing at minimum a label and value attribute
optionally a subLabel property can be passed
### defaultSelected
**`Object|String`**
_Optional_
value of the option selected by default
### close
**`Function`**
_Required_
func that closes the popover
### styleMixin
**`Object`**
_Optional_
object containing any style properties to mixin with and/or overrride the defaults
note that width height are passed separately so they can have defaults and auto settings
passing widt/height in this object could cause issues
### onChange
**`Function`**
_Required_
method to call when the non selected option is clicked
### hideSelected
**`Boolean`**
_Optional_
when on, the defaultSelected option will be removed from the list
### headerTitle
**`String`**
_Optional_
optional title String for popover header
### headerClass
**`String`**
_Optional_
optional class for popover header
### maxHeight
**`Number`**
_Optional_
the maximum height the popover should be. used to set height on the pvr if this is
lower than the computed height.
### pvrProps
**`Object`**
_Optional_
properties germane to PVR wrapper: width, height, anchor, hAdjust, vAdjust, direction