From cce423295ec432b87bfc5d5c277498a3a630fd45 Mon Sep 17 00:00:00 2001 From: Miguel Torres Date: Thu, 2 Aug 2018 08:08:56 +0200 Subject: [PATCH] Add components examples in README.md files - Part 1 (#8267) * Components examples: Button * Components examples: ButtonGroup * Components examples: Dashicon * Components examples: Disabled * Components examples: Draggable * Components examples: ClipboardButton * Components examples: CheckboxControl * Components examples: BaseControl * Components examples: Autocomplete * Components examples: Adding imports and using functional components * Components examples: ColorPalette * Components examples: DropZone * Components examples: Dropdown * Components examples: DropdownMenu * Components examples: ExternalLink * Components examples: FocusableIframe * Components examples: FontSizePicker * Components examples: FormFileUpload * Components examples: FormToggle * Components examples: FormTokenField * Components examples: ColorIndicator * Components examples: IconButton * Components examples: KeyboardShortcuts * Components examples: MenuGroup and MenuItem * Components examples: MenuItemsChoice * Using hashes instead of equality signs for the README main header * Using https://wordpress.org instead of .com * Using checked property in the CheckboxControl example * Change text used in the ClipboardButton example * Better format in colors array used in the ColorPalette example * Placing variable in arrow function between parenthesis * Add a dynamic message to DropZone example * Code style according to linter in FocusableIframe example * Add missing semicolons to FontSizePicker example * Add fallbackFontSize to FontSizePicker example * Add missing whitespaces in suggestions array * Use MenuItem in MenuGroup example --- .../components/src/autocomplete/README.md | 77 ++++++++++++------- .../components/src/base-control/README.md | 29 +++---- .../components/src/button-group/README.md | 16 ++++ packages/components/src/button/README.md | 5 +- .../components/src/checkbox-control/README.md | 24 +++--- .../components/src/clipboard-button/README.md | 21 +++++ .../components/src/color-indicator/README.md | 13 ++++ .../components/src/color-palette/README.md | 25 ++++++ packages/components/src/dashicon/README.md | 17 ++++ packages/components/src/date-time/README.md | 3 +- packages/components/src/disabled/README.md | 31 ++++---- packages/components/src/draggable/README.md | 23 ++++++ packages/components/src/drop-zone/README.md | 26 ++++--- .../components/src/dropdown-menu/README.md | 13 ++-- packages/components/src/dropdown/README.md | 9 +-- .../components/src/external-link/README.md | 13 ++++ .../components/src/focusable-iframe/README.md | 7 +- .../components/src/font-size-picker/README.md | 35 +++++---- .../components/src/form-file-upload/README.md | 18 +++++ packages/components/src/form-toggle/README.md | 17 ++++ .../components/src/form-token-field/README.md | 35 ++++----- packages/components/src/icon-button/README.md | 16 ++++ .../src/keyboard-shortcuts/README.md | 46 +++++------ packages/components/src/menu-group/README.md | 16 ++++ packages/components/src/menu-item/README.md | 20 +++++ .../src/menu-items-choice/README.md | 30 ++++++++ 26 files changed, 431 insertions(+), 154 deletions(-) create mode 100644 packages/components/src/button-group/README.md create mode 100644 packages/components/src/clipboard-button/README.md create mode 100644 packages/components/src/color-indicator/README.md create mode 100644 packages/components/src/color-palette/README.md create mode 100644 packages/components/src/dashicon/README.md create mode 100644 packages/components/src/external-link/README.md create mode 100644 packages/components/src/form-file-upload/README.md create mode 100644 packages/components/src/form-toggle/README.md create mode 100644 packages/components/src/icon-button/README.md create mode 100644 packages/components/src/menu-group/README.md create mode 100644 packages/components/src/menu-item/README.md create mode 100644 packages/components/src/menu-items-choice/README.md diff --git a/packages/components/src/autocomplete/README.md b/packages/components/src/autocomplete/README.md index 102f88d453250..fe7a467dfd30b 100644 --- a/packages/components/src/autocomplete/README.md +++ b/packages/components/src/autocomplete/README.md @@ -1,5 +1,4 @@ -Autocomplete -============ +# Autocomplete This component is used to provide autocompletion support for a child input component. @@ -105,33 +104,59 @@ Whether to apply debouncing for the autocompleter. Set to true to enable debounc - Type: `Boolean` - Required: No -### Examples +## Usage The following is a contrived completer for fresh fruit. ```jsx -const fruitCompleter = { - name: 'fruit', - // The prefix that triggers this completer - triggerPrefix: '~', - // The option data - options: [ - { visual: '🍎', name: 'Apple' }, - { visual: '🍊', name: 'Orange' }, - { visual: '🍇', name: 'Grapes' }, - ], - // Returns a label for an option like "🍊 Orange" - getOptionLabel: option => [ - { option.visual }, - option.name - ], - // Declares that options should be matched by their name - getOptionKeywords: option => [ option.name ], - // Declares that the Grapes option is disabled - isOptionDisabled: option => option.name === 'Grapes', - // Declares completions should be inserted as abbreviations - getOptionCompletion: option => ( - { option.visual } - ), +import { Autocomplete } from '@wordpress/components'; + +function FreshFruitAutocomplete() { + const autocompleters = [ + { + name: 'fruit', + // The prefix that triggers this completer + triggerPrefix: '~', + // The option data + options: [ + { visual: '🍎', name: 'Apple', id: 1 }, + { visual: '🍊', name: 'Orange', id: 2 }, + { visual: '🍇', name: 'Grapes', id: 3 }, + ], + // Returns a label for an option like "🍊 Orange" + getOptionLabel: option => ( + + { option.visual }{ option.name } + + ), + // Declares that options should be matched by their name + getOptionKeywords: option => [ option.name ], + // Declares that the Grapes option is disabled + isOptionDisabled: option => option.name === 'Grapes', + // Declares completions should be inserted as abbreviations + getOptionCompletion: option => ( + { option.visual } + ), + } + ]; + + return ( +
+ + { ( { isExpanded, listBoxId, activeId } ) => ( +
+
+ ) } +
+

Type ~ for triggering the autocomplete.

+
+ ); }; ``` diff --git a/packages/components/src/base-control/README.md b/packages/components/src/base-control/README.md index ac2dc6249714a..1dd091908176d 100644 --- a/packages/components/src/base-control/README.md +++ b/packages/components/src/base-control/README.md @@ -1,5 +1,4 @@ -BaseControl -======= +# BaseControl BaseControl component is used to generate labels and help text for components handling user inputs. @@ -8,17 +7,21 @@ BaseControl component is used to generate labels and help text for components ha Render a BaseControl for a textarea input: ```jsx - -