28 lines
1.5 KiB
Markdown
28 lines
1.5 KiB
Markdown
|
<!--THIS FILE IS AUTO GENERATED. This file is generated from JSDoc comments in lib/core/addon/components/ttl-picker.js. To make changes, first edit that file and run "yarn gen-story-md ttl-picker" to re-generate the content.-->
|
||
|
|
|
||
|
|
## TtlPicker
|
||
|
|
`TtlPicker` components are used to expand and collapse content with a toggle.
|
||
|
|
|
||
|
|
|
||
|
|
| Param | Type | Default | Description |
|
||
|
|
| --- | --- | --- | --- |
|
||
|
|
| labelClass | <code>String</code> | <code>""</code> | A CSS class to add to the label. |
|
||
|
|
| labelText | <code>String</code> | <code>"TTL"</code> | The text content of the label associated with the widget. |
|
||
|
|
| initialValue | <code>Number</code> | <code></code> | The starting value of the TTL; |
|
||
|
|
| setDefaultValue | <code>Boolean</code> | <code>true</code> | If true, the component will trigger onChange on the initial render, causing a value to be set. |
|
||
|
|
| onChange | <code>function</code> | <code>Function.prototype</code> | The function to call when the value of the ttl changes. |
|
||
|
|
| outputSeconds | <code>Boolean</code> | <code>false</code> | If true, the component will trigger onChange with a value converted to seconds instead of a Golang duration string. |
|
||
|
|
|
||
|
|
**Example**
|
||
|
|
|
||
|
|
```js
|
||
|
|
<TtlPicker @labelText="Lease" @initialValue={{lease}} @onChange={{action (mut lease)}} />
|
||
|
|
```
|
||
|
|
|
||
|
|
**See**
|
||
|
|
|
||
|
|
- [Uses of TtlPicker](https://github.com/hashicorp/vault/search?l=Handlebars&q=TtlPicker)
|
||
|
|
- [TtlPicker Source Code](https://github.com/hashicorp/vault/blob/master/ui/app/components/ttl-picker.js)
|
||
|
|
|
||
|
|
---
|