Skip to content

Commit ed55ffa

Browse files
committed
Revise
1 parent 6c4ae3a commit ed55ffa

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

components/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -770,7 +770,7 @@ You can override the default stacking behavior by specifying `{customStacking: t
770770

771771
### choose
772772

773-
Creates a modal that lets the user choose among given options, returns a `Promise` that resolves when user makes the choice (resolves to the selected string), or cancels (resolves to `undefined`).
773+
Creates a [`Modal`](#modal) component that lets the user choose among given options, returns a [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) that resolves when user makes the choice (resolves to the selected string), or cancels (resolves to `undefined`).
774774

775775
#### Signature
776776

@@ -816,7 +816,7 @@ selected && van.add(document.body, div("You chose: ", b(selected)))
816816
* `label`: Type `string`. Required. The label you want to show.
817817
* `options`: Type `string[]`. Required. The options of the choice.
818818
* `selectedColor`: Type `string`. Default `#f5f5f5`. Optional. The background color of the currently selected option.
819-
* `customModalProps`: Type: property bags for the [Modal](#modal) component (except the `closed` field). Default `{}`. Optional. The custom properties for the `Modal` component you want to specify.
819+
* `customModalProps`: Type: property bags for the [`Modal`](#modal) component (except the `closed` field). Default `{}`. Optional. The custom properties for the `Modal` component you want to specify.
820820
* `textFilterClass`: Type `string`. Default `""`. Optional. The `class` attribute of the text filter. You can specify multiple CSS classes separated by `" "`.
821821
* `textFilterStyleOverrides`: Type `Record<string, string | number>`. Default `{}`. Optional. A [property bag](#property-bag-for-style-overrides) for the styles you want to override for the text filter.
822822
* `optionsContainerClass`: Type `string`. Default `""`. Optional. The `class` attribute of the container of all options. You can specify multiple CSS classes separated by `" "`.

0 commit comments

Comments
 (0)