docs(Dropdown): added comments for shape of options (#1086)

docs(Dropdown): added comments for shape of options
Semantic-Org · Dec 27, 2016 · bcdf523 · bcdf523
1 parent 192d0d7
commit bcdf523
Show file tree

Hide file tree

Showing 9 changed files with 39 additions and 0 deletions.
diff --git a/docs/app/Examples/modules/Dropdown/Types/DropdownExampleInline.js b/docs/app/Examples/modules/Dropdown/Types/DropdownExampleInline.js
@@ -2,6 +2,14 @@ import React from 'react'
 import { Dropdown } from 'semantic-ui-react'
 
 import { friendOptions } from '../common'
+// friendOptions = [
+//   {
+//     text: 'Jenny Hess',
+//     value: 'Jenny Hess',
+//     image: { avatar: true, src: '/assets/images/avatar/small/jenny.jpg' },
+//   },
+//   ...
+// ]
 
 const DropdownExampleInline = () => (
   <span>

diff --git a/docs/app/Examples/modules/Dropdown/Types/DropdownExampleMultipleSearchInMenu.js b/docs/app/Examples/modules/Dropdown/Types/DropdownExampleMultipleSearchInMenu.js
@@ -2,6 +2,15 @@ import React from 'react'
 import { Dropdown, Input } from 'semantic-ui-react'
 
 import { tagOptions } from '../common'
+// tagOptions = [
+//   {
+//     text: 'Important',
+//     value: 'Important',
+//     label: { color: 'red', empty: true, circular: true },
+//   },
+//   ...
+// ]
+
 
 const DropdownExampleMultipleSearchInMenu = () => (
   <Dropdown text='Filter Posts' multiple>

diff --git a/docs/app/Examples/modules/Dropdown/Types/DropdownExampleMultipleSearchSelection.js b/docs/app/Examples/modules/Dropdown/Types/DropdownExampleMultipleSearchSelection.js
@@ -2,6 +2,7 @@ import React from 'react'
 import { Dropdown } from 'semantic-ui-react'
 
 import { stateOptions } from '../common'
+// stateOptions = [ { value: 'AL', text: 'Alabama' }, ...  ]
 
 const DropdownExampleMultipleSearchSelection = () => (
   <Dropdown placeholder='State' fluid multiple search selection options={stateOptions} />

diff --git a/docs/app/Examples/modules/Dropdown/Types/DropdownExampleMultipleSearchSelectionTwo.js b/docs/app/Examples/modules/Dropdown/Types/DropdownExampleMultipleSearchSelectionTwo.js
@@ -2,6 +2,7 @@ import React from 'react'
 import { Dropdown } from 'semantic-ui-react'
 
 import { countryOptions } from '../common'
+// countryOptions = [ { value: 'af', flag: 'af', text: 'Afghanistan' }, ...  ]
 
 const DropdownExampleMultipleSearchSelectionTwo = () => (
   <Dropdown placeholder='Select Country' fluid multiple search selection options={countryOptions} />

diff --git a/docs/app/Examples/modules/Dropdown/Types/DropdownExampleSearchDropdown.js b/docs/app/Examples/modules/Dropdown/Types/DropdownExampleSearchDropdown.js
@@ -2,6 +2,7 @@ import React from 'react'
 import { Dropdown } from 'semantic-ui-react'
 
 import { languageOptions } from '../common'
+// languageOptions = [ { text: 'Arabic', value: 'Arabic' }, ...  ]
 
 /**
  * NOTE: In this example, the dropdown should contain a label on the

diff --git a/docs/app/Examples/modules/Dropdown/Types/DropdownExampleSearchInMenu.js b/docs/app/Examples/modules/Dropdown/Types/DropdownExampleSearchInMenu.js
@@ -2,6 +2,14 @@ import React from 'react'
 import { Dropdown, Input } from 'semantic-ui-react'
 
 import { tagOptions } from '../common'
+// tagOptions = [
+//   {
+//     text: 'Important',
+//     value: 'Important',
+//     label: { color: 'red', empty: true, circular: true },
+//   },
+//   ...
+// ]
 
 const DropdownExampleSearchInMenu = () => (
   <Dropdown text='Filter Posts' floating labeled button className='icon'>

diff --git a/docs/app/Examples/modules/Dropdown/Types/DropdownExampleSearchSelection.js b/docs/app/Examples/modules/Dropdown/Types/DropdownExampleSearchSelection.js
@@ -2,6 +2,7 @@ import React from 'react'
 import { Dropdown } from 'semantic-ui-react'
 
 import { countryOptions } from '../common'
+// countryOptions = [ { value: 'af', flag: 'af', text: 'Afghanistan' }, ...  ]
 
 const DropdownExampleSearchSelection = () => (
   <Dropdown placeholder='Select Country' fluid search selection options={countryOptions} />

diff --git a/docs/app/Examples/modules/Dropdown/Types/DropdownExampleSearchSelectionTwo.js b/docs/app/Examples/modules/Dropdown/Types/DropdownExampleSearchSelectionTwo.js
@@ -2,6 +2,7 @@ import React from 'react'
 import { Dropdown } from 'semantic-ui-react'
 
 import { stateOptions } from '../common'
+// stateOptions = [ { value: 'AL', text: 'Alabama' }, ...  ]
 
 const DropdownExampleSearchSelectionTwo = () => (
   <Dropdown placeholder='State' search selection options={stateOptions} />

diff --git a/docs/app/Examples/modules/Dropdown/Types/DropdownExampleSelection.js b/docs/app/Examples/modules/Dropdown/Types/DropdownExampleSelection.js
@@ -2,6 +2,15 @@ import React from 'react'
 import { Dropdown } from 'semantic-ui-react'
 
 import { friendOptions } from '../common'
+// friendOptions = [
+//   {
+//     text: 'Jenny Hess',
+//     value: 'Jenny Hess',
+//     image: { avatar: true, src: '/assets/images/avatar/small/jenny.jpg' },
+//   },
+//  ...
+// ]
+
 
 const DropdownExampleSelection = () => (
   <Dropdown placeholder='Select Friend' fluid selection options={friendOptions} />