Navigation Menu

Skip to content
This repository has been archived by the owner on Mar 3, 2023. It is now read-only.

Commit

Permalink
Document radio: true option introduced in atom/settings-view#1089
Browse files Browse the repository at this point in the history
  • Loading branch information
okbel committed Apr 5, 2019
1 parent 7acb843 commit 5a4cfeb
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions src/config.js
Expand Up @@ -265,6 +265,22 @@ const schemaEnforcers = {}
// ]
// ```
//
// If you only have a few elements, you can display your enum as a list of
// radio buttons in the settings view rather than a select list. To do so,
// specify `radio: true` as a sibling property to the `enum` array.
//
// ```coffee
// config:
// someSetting:
// type: 'string'
// default: 'foo'
// enum: [
// {value: 'foo', description: 'Foo mode. You want this.'}
// {value: 'bar', description: 'Bar mode. Nobody wants that!'}
// ]
// radio: true
// ```
//
// Usage:
//
// ```coffee
Expand Down

0 comments on commit 5a4cfeb

Please sign in to comment.