Skip to content

Commit

Permalink
docs: update mentions of DirectionProvider to ConfigProvider (#1109)
Browse files Browse the repository at this point in the history
  • Loading branch information
romansp authored Jul 9, 2024
1 parent ee5ee67 commit 04bd48d
Show file tree
Hide file tree
Showing 34 changed files with 34 additions and 34 deletions.
2 changes: 1 addition & 1 deletion docs/content/meta/ComboboxRoot.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
},
{
'name': 'dir',
'description': '<p>The reading direction of the combobox when applicable. &lt;br&gt; If omitted, inherits globally from <code>DirectionProvider</code> or assumes LTR (left-to-right) reading mode.</p>\n',
'description': '<p>The reading direction of the combobox when applicable. &lt;br&gt; If omitted, inherits globally from <code>ConfigProvider</code> or assumes LTR (left-to-right) reading mode.</p>\n',
'type': '\'ltr\' | \'rtl\'',
'required': false
},
Expand Down
2 changes: 1 addition & 1 deletion docs/content/meta/ContextMenuRoot.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<PropsTable :data="[
{
'name': 'dir',
'description': '<p>The reading direction of the combobox when applicable.</p>\n<p>If omitted, inherits globally from <code>DirectionProvider</code> or assumes LTR (left-to-right) reading mode.</p>\n',
'description': '<p>The reading direction of the combobox when applicable.</p>\n<p>If omitted, inherits globally from <code>ConfigProvider</code> or assumes LTR (left-to-right) reading mode.</p>\n',
'type': '\'ltr\' | \'rtl\'',
'required': false
},
Expand Down
2 changes: 1 addition & 1 deletion docs/content/meta/DropdownMenuRoot.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
},
{
'name': 'dir',
'description': '<p>The reading direction of the combobox when applicable.</p>\n<p>If omitted, inherits globally from <code>DirectionProvider</code> or assumes LTR (left-to-right) reading mode.</p>\n',
'description': '<p>The reading direction of the combobox when applicable.</p>\n<p>If omitted, inherits globally from <code>ConfigProvider</code> or assumes LTR (left-to-right) reading mode.</p>\n',
'type': '\'ltr\' | \'rtl\'',
'required': false
},
Expand Down
2 changes: 1 addition & 1 deletion docs/content/meta/ListboxRoot.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
},
{
'name': 'dir',
'description': '<p>The reading direction of the listbox when applicable. &lt;br&gt; If omitted, inherits globally from <code>DirectionProvider</code> or assumes LTR (left-to-right) reading mode.</p>\n',
'description': '<p>The reading direction of the listbox when applicable. &lt;br&gt; If omitted, inherits globally from <code>ConfigProvider</code> or assumes LTR (left-to-right) reading mode.</p>\n',
'type': '\'ltr\' | \'rtl\'',
'required': false
},
Expand Down
2 changes: 1 addition & 1 deletion docs/content/meta/MenubarRoot.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
},
{
'name': 'dir',
'description': '<p>The reading direction of the combobox when applicable.</p>\n<p>If omitted, inherits globally from <code>DirectionProvider</code> or assumes LTR (left-to-right) reading mode.</p>\n',
'description': '<p>The reading direction of the combobox when applicable.</p>\n<p>If omitted, inherits globally from <code>ConfigProvider</code> or assumes LTR (left-to-right) reading mode.</p>\n',
'type': '\'ltr\' | \'rtl\'',
'required': false
},
Expand Down
2 changes: 1 addition & 1 deletion docs/content/meta/NavigationMenuRoot.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
},
{
'name': 'dir',
'description': '<p>The reading direction of the combobox when applicable.</p>\n<p>If omitted, inherits globally from <code>DirectionProvider</code> or assumes LTR (left-to-right) reading mode.</p>\n',
'description': '<p>The reading direction of the combobox when applicable.</p>\n<p>If omitted, inherits globally from <code>ConfigProvider</code> or assumes LTR (left-to-right) reading mode.</p>\n',
'type': '\'ltr\' | \'rtl\'',
'required': false
},
Expand Down
2 changes: 1 addition & 1 deletion docs/content/meta/PinInputRoot.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
},
{
'name': 'dir',
'description': '<p>The reading direction of the combobox when applicable. &lt;br&gt; If omitted, inherits globally from <code>DirectionProvider</code> or assumes LTR (left-to-right) reading mode.</p>\n',
'description': '<p>The reading direction of the combobox when applicable. &lt;br&gt; If omitted, inherits globally from <code>ConfigProvider</code> or assumes LTR (left-to-right) reading mode.</p>\n',
'type': '\'ltr\' | \'rtl\'',
'required': false
},
Expand Down
2 changes: 1 addition & 1 deletion docs/content/meta/RadioGroupRoot.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
},
{
'name': 'dir',
'description': '<p>The reading direction of the combobox when applicable. &lt;br&gt; If omitted, inherits globally from <code>DirectionProvider</code> or assumes LTR (left-to-right) reading mode.</p>\n',
'description': '<p>The reading direction of the combobox when applicable. &lt;br&gt; If omitted, inherits globally from <code>ConfigProvider</code> or assumes LTR (left-to-right) reading mode.</p>\n',
'type': '\'ltr\' | \'rtl\'',
'required': false
},
Expand Down
2 changes: 1 addition & 1 deletion docs/content/meta/ScrollAreaRoot.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
},
{
'name': 'dir',
'description': '<p>The reading direction of the combobox when applicable. &lt;br&gt; If omitted, inherits globally from <code>DirectionProvider</code> or assumes LTR (left-to-right) reading mode.</p>\n',
'description': '<p>The reading direction of the combobox when applicable. &lt;br&gt; If omitted, inherits globally from <code>ConfigProvider</code> or assumes LTR (left-to-right) reading mode.</p>\n',
'type': '\'ltr\' | \'rtl\'',
'required': false
},
Expand Down
2 changes: 1 addition & 1 deletion docs/content/meta/SelectRoot.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
},
{
'name': 'dir',
'description': '<p>The reading direction of the combobox when applicable. &lt;br&gt; If omitted, inherits globally from <code>DirectionProvider</code> or assumes LTR (left-to-right) reading mode.</p>\n',
'description': '<p>The reading direction of the combobox when applicable. &lt;br&gt; If omitted, inherits globally from <code>ConfigProvider</code> or assumes LTR (left-to-right) reading mode.</p>\n',
'type': '\'ltr\' | \'rtl\'',
'required': false
},
Expand Down
2 changes: 1 addition & 1 deletion docs/content/meta/SliderRoot.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
},
{
'name': 'dir',
'description': '<p>The reading direction of the combobox when applicable. &lt;br&gt; If omitted, inherits globally from <code>DirectionProvider</code> or assumes LTR (left-to-right) reading mode.</p>\n',
'description': '<p>The reading direction of the combobox when applicable. &lt;br&gt; If omitted, inherits globally from <code>ConfigProvider</code> or assumes LTR (left-to-right) reading mode.</p>\n',
'type': '\'ltr\' | \'rtl\'',
'required': false
},
Expand Down
2 changes: 1 addition & 1 deletion docs/content/meta/StepperRoot.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
},
{
'name': 'dir',
'description': '<p>The reading direction of the combobox when applicable. &lt;br&gt; If omitted, inherits globally from <code>DirectionProvider</code> or assumes LTR (left-to-right) reading mode.</p>\n',
'description': '<p>The reading direction of the combobox when applicable. &lt;br&gt; If omitted, inherits globally from <code>ConfigProvider</code> or assumes LTR (left-to-right) reading mode.</p>\n',
'type': '\'ltr\' | \'rtl\'',
'required': false
},
Expand Down
2 changes: 1 addition & 1 deletion docs/content/meta/TabsRoot.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
},
{
'name': 'dir',
'description': '<p>The reading direction of the combobox when applicable. &lt;br&gt; If omitted, inherits globally from <code>DirectionProvider</code> or assumes LTR (left-to-right) reading mode.</p>\n',
'description': '<p>The reading direction of the combobox when applicable. &lt;br&gt; If omitted, inherits globally from <code>ConfigProvider</code> or assumes LTR (left-to-right) reading mode.</p>\n',
'type': '\'ltr\' | \'rtl\'',
'required': false
},
Expand Down
2 changes: 1 addition & 1 deletion docs/content/meta/TagsInputRoot.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
},
{
'name': 'dir',
'description': '<p>The reading direction of the combobox when applicable. &lt;br&gt; If omitted, inherits globally from <code>DirectionProvider</code> or assumes LTR (left-to-right) reading mode.</p>\n',
'description': '<p>The reading direction of the combobox when applicable. &lt;br&gt; If omitted, inherits globally from <code>ConfigProvider</code> or assumes LTR (left-to-right) reading mode.</p>\n',
'type': '\'ltr\' | \'rtl\'',
'required': false
},
Expand Down
2 changes: 1 addition & 1 deletion docs/content/meta/ToggleGroupRoot.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
},
{
'name': 'dir',
'description': '<p>The reading direction of the combobox when applicable. &lt;br&gt; If omitted, inherits globally from <code>DirectionProvider</code> or assumes LTR (left-to-right) reading mode.</p>\n',
'description': '<p>The reading direction of the combobox when applicable. &lt;br&gt; If omitted, inherits globally from <code>ConfigProvider</code> or assumes LTR (left-to-right) reading mode.</p>\n',
'type': '\'ltr\' | \'rtl\'',
'required': false
},
Expand Down
2 changes: 1 addition & 1 deletion docs/content/meta/ToolbarRoot.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
},
{
'name': 'dir',
'description': '<p>The reading direction of the combobox when applicable. &lt;br&gt; If omitted, inherits globally from <code>DirectionProvider</code> or assumes LTR (left-to-right) reading mode.</p>\n',
'description': '<p>The reading direction of the combobox when applicable. &lt;br&gt; If omitted, inherits globally from <code>ConfigProvider</code> or assumes LTR (left-to-right) reading mode.</p>\n',
'type': '\'ltr\' | \'rtl\'',
'required': false
},
Expand Down
2 changes: 1 addition & 1 deletion docs/content/meta/ToolbarToggleGroup.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
},
{
'name': 'dir',
'description': '<p>The reading direction of the combobox when applicable. &lt;br&gt; If omitted, inherits globally from <code>DirectionProvider</code> or assumes LTR (left-to-right) reading mode.</p>\n',
'description': '<p>The reading direction of the combobox when applicable. &lt;br&gt; If omitted, inherits globally from <code>ConfigProvider</code> or assumes LTR (left-to-right) reading mode.</p>\n',
'type': '\'ltr\' | \'rtl\'',
'required': false
},
Expand Down
2 changes: 1 addition & 1 deletion docs/content/meta/TreeRoot.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
},
{
'name': 'dir',
'description': '<p>The reading direction of the listbox when applicable. &lt;br&gt; If omitted, inherits globally from <code>DirectionProvider</code> or assumes LTR (left-to-right) reading mode.</p>\n',
'description': '<p>The reading direction of the listbox when applicable. &lt;br&gt; If omitted, inherits globally from <code>ConfigProvider</code> or assumes LTR (left-to-right) reading mode.</p>\n',
'type': '\'ltr\' | \'rtl\'',
'required': false
},
Expand Down
2 changes: 1 addition & 1 deletion packages/radix-vue/src/Combobox/ComboboxRoot.vue
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ export interface ComboboxRootProps<T = AcceptableValue> extends PrimitiveProps {
disabled?: boolean
/** The name of the Combobox. Submitted with its owning form as part of a name/value pair. */
name?: string
/** The reading direction of the combobox when applicable. <br> If omitted, inherits globally from `DirectionProvider` or assumes LTR (left-to-right) reading mode. */
/** The reading direction of the combobox when applicable. <br> If omitted, inherits globally from `ConfigProvider` or assumes LTR (left-to-right) reading mode. */
dir?: Direction
/** The custom filter function for filtering `ComboboxItem`. */
filterFunction?: (val: ArrayOrWrapped<T>, term: string) => ArrayOrWrapped<T>
Expand Down
2 changes: 1 addition & 1 deletion packages/radix-vue/src/Listbox/ListboxRoot.vue
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ export interface ListboxRootProps<T = AcceptableValue> extends PrimitiveProps {
multiple?: boolean
/** The orientation of the listbox. <br>Mainly so arrow navigation is done accordingly (left & right vs. up & down) */
orientation?: DataOrientation
/** The reading direction of the listbox when applicable. <br> If omitted, inherits globally from `DirectionProvider` or assumes LTR (left-to-right) reading mode. */
/** The reading direction of the listbox when applicable. <br> If omitted, inherits globally from `ConfigProvider` or assumes LTR (left-to-right) reading mode. */
dir?: Direction
/** When `true`, prevents the user from interacting with listbox */
disabled?: boolean
Expand Down
2 changes: 1 addition & 1 deletion packages/radix-vue/src/Menu/MenuRoot.vue
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ export interface MenuProps {
/**
* The reading direction of the combobox when applicable.
*
* If omitted, inherits globally from `DirectionProvider` or assumes LTR (left-to-right) reading mode.
* If omitted, inherits globally from `ConfigProvider` or assumes LTR (left-to-right) reading mode.
*/
dir?: Direction
/**
Expand Down
2 changes: 1 addition & 1 deletion packages/radix-vue/src/Menubar/MenubarRoot.vue
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ export interface MenubarRootProps {
/**
* The reading direction of the combobox when applicable.
*
* If omitted, inherits globally from `DirectionProvider` or assumes LTR (left-to-right) reading mode.
* If omitted, inherits globally from `ConfigProvider` or assumes LTR (left-to-right) reading mode.
*/
dir?: Direction
/** When `true`, keyboard navigation will loop from last item to first, and vice versa. */
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ export interface NavigationMenuRootProps extends PrimitiveProps {
/**
* The reading direction of the combobox when applicable.
*
* If omitted, inherits globally from `DirectionProvider` or assumes LTR (left-to-right) reading mode.
* If omitted, inherits globally from `ConfigProvider` or assumes LTR (left-to-right) reading mode.
*/
dir?: Direction
/** The orientation of the menu. */
Expand Down
2 changes: 1 addition & 1 deletion packages/radix-vue/src/PinInput/PinInputRoot.vue
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ export interface PinInputRootProps extends PrimitiveProps {
otp?: boolean
/** Input type for the inputs. */
type?: 'text' | 'number'
/** The reading direction of the combobox when applicable. <br> If omitted, inherits globally from `DirectionProvider` or assumes LTR (left-to-right) reading mode. */
/** The reading direction of the combobox when applicable. <br> If omitted, inherits globally from `ConfigProvider` or assumes LTR (left-to-right) reading mode. */
dir?: Direction
/** The name of the pin input. Submitted with its owning form as part of a name/value pair. */
name?: string
Expand Down
2 changes: 1 addition & 1 deletion packages/radix-vue/src/RadioGroup/RadioGroupRoot.vue
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ export interface RadioGroupRootProps extends PrimitiveProps {
required?: boolean
/** The orientation of the component. */
orientation?: DataOrientation
/** The reading direction of the combobox when applicable. <br> If omitted, inherits globally from `DirectionProvider` or assumes LTR (left-to-right) reading mode. */
/** The reading direction of the combobox when applicable. <br> If omitted, inherits globally from `ConfigProvider` or assumes LTR (left-to-right) reading mode. */
dir?: Direction
/** When `true`, keyboard navigation will loop from last item to first, and vice versa. */
loop?: boolean
Expand Down
2 changes: 1 addition & 1 deletion packages/radix-vue/src/ScrollArea/ScrollAreaRoot.vue
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ export interface ScrollAreaRootProps extends PrimitiveProps {
* `hover` - when the user is scrolling along its corresponding orientation and when the user is hovering over the scroll area.
*/
type?: ScrollType
/** The reading direction of the combobox when applicable. <br> If omitted, inherits globally from `DirectionProvider` or assumes LTR (left-to-right) reading mode. */
/** The reading direction of the combobox when applicable. <br> If omitted, inherits globally from `ConfigProvider` or assumes LTR (left-to-right) reading mode. */
dir?: Direction
/** If type is set to either `scroll` or `hover`, this prop determines the length of time, in milliseconds, <br> before the scrollbars are hidden after the user stops interacting with scrollbars. */
scrollHideDelay?: number
Expand Down
2 changes: 1 addition & 1 deletion packages/radix-vue/src/Select/SelectRoot.vue
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ export interface SelectRootProps {
defaultValue?: string
/** The controlled value of the Select. Can be bind as `v-model`. */
modelValue?: string
/** The reading direction of the combobox when applicable. <br> If omitted, inherits globally from `DirectionProvider` or assumes LTR (left-to-right) reading mode. */
/** The reading direction of the combobox when applicable. <br> If omitted, inherits globally from `ConfigProvider` or assumes LTR (left-to-right) reading mode. */
dir?: Direction
/** The name of the Select. Submitted with its owning form as part of a name/value pair. */
name?: string
Expand Down
2 changes: 1 addition & 1 deletion packages/radix-vue/src/Slider/SliderRoot.vue
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ export interface SliderRootProps extends PrimitiveProps {
disabled?: boolean
/** The orientation of the slider. */
orientation?: DataOrientation
/** The reading direction of the combobox when applicable. <br> If omitted, inherits globally from `DirectionProvider` or assumes LTR (left-to-right) reading mode. */
/** The reading direction of the combobox when applicable. <br> If omitted, inherits globally from `ConfigProvider` or assumes LTR (left-to-right) reading mode. */
dir?: Direction
/** Whether the slider is visually inverted. */
inverted?: boolean
Expand Down
2 changes: 1 addition & 1 deletion packages/radix-vue/src/Stepper/StepperRoot.vue
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ export interface StepperRootProps extends PrimitiveProps {
*/
orientation?: DataOrientation
/**
* The reading direction of the combobox when applicable. <br> If omitted, inherits globally from `DirectionProvider` or assumes LTR (left-to-right) reading mode.
* The reading direction of the combobox when applicable. <br> If omitted, inherits globally from `ConfigProvider` or assumes LTR (left-to-right) reading mode.
*/
dir?: Direction
/** The controlled value of the tab to activate. Can be bound as `v-model`. */
Expand Down
2 changes: 1 addition & 1 deletion packages/radix-vue/src/Tabs/TabsRoot.vue
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ export interface TabsRootProps<T extends StringOrNumber = StringOrNumber> extend
*/
orientation?: DataOrientation
/**
* The reading direction of the combobox when applicable. <br> If omitted, inherits globally from `DirectionProvider` or assumes LTR (left-to-right) reading mode.
* The reading direction of the combobox when applicable. <br> If omitted, inherits globally from `ConfigProvider` or assumes LTR (left-to-right) reading mode.
*/
dir?: Direction
/**
Expand Down
2 changes: 1 addition & 1 deletion packages/radix-vue/src/TagsInput/TagsInputRoot.vue
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ export interface TagsInputRootProps<T = AcceptableInputValue> extends PrimitiveP
disabled?: boolean
/** The character to trigger the addition of a new tag. Also used to split tags for `@paste` event */
delimiter?: string
/** The reading direction of the combobox when applicable. <br> If omitted, inherits globally from `DirectionProvider` or assumes LTR (left-to-right) reading mode. */
/** The reading direction of the combobox when applicable. <br> If omitted, inherits globally from `ConfigProvider` or assumes LTR (left-to-right) reading mode. */
dir?: Direction
/** Maximum number of tags. */
max?: number
Expand Down
2 changes: 1 addition & 1 deletion packages/radix-vue/src/ToggleGroup/ToggleGroupRoot.vue
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ export interface ToggleGroupRootProps<ValidValue = string | string[], ExplicitTy
disabled?: boolean
/** The orientation of the component, which determines how focus moves: `horizontal` for left/right arrows and `vertical` for up/down arrows. */
orientation?: DataOrientation
/** The reading direction of the combobox when applicable. <br> If omitted, inherits globally from `DirectionProvider` or assumes LTR (left-to-right) reading mode. */
/** The reading direction of the combobox when applicable. <br> If omitted, inherits globally from `ConfigProvider` or assumes LTR (left-to-right) reading mode. */
dir?: Direction
/** When `loop` and `rovingFocus` is `true`, keyboard navigation will loop from last item to first, and vice versa. */
loop?: boolean
Expand Down
2 changes: 1 addition & 1 deletion packages/radix-vue/src/Toolbar/ToolbarRoot.vue
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { createContext, useDirection, useForwardExpose } from '@/shared'
export interface ToolbarRootProps extends PrimitiveProps {
/** The orientation of the toolbar */
orientation?: DataOrientation
/** The reading direction of the combobox when applicable. <br> If omitted, inherits globally from `DirectionProvider` or assumes LTR (left-to-right) reading mode. */
/** The reading direction of the combobox when applicable. <br> If omitted, inherits globally from `ConfigProvider` or assumes LTR (left-to-right) reading mode. */
dir?: Direction
/** When `true`, keyboard navigation will loop from last tab to first, and vice versa. */
loop?: boolean
Expand Down
2 changes: 1 addition & 1 deletion packages/radix-vue/src/Tree/TreeRoot.vue
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ export interface TreeRootProps<T = Record<string, any>, U extends Record<string,
selectionBehavior?: 'toggle' | 'replace'
/** Whether multiple options can be selected or not. */
multiple?: boolean
/** The reading direction of the listbox when applicable. <br> If omitted, inherits globally from `DirectionProvider` or assumes LTR (left-to-right) reading mode. */
/** The reading direction of the listbox when applicable. <br> If omitted, inherits globally from `ConfigProvider` or assumes LTR (left-to-right) reading mode. */
dir?: Direction
/** When `true`, prevents the user from interacting with tree */
disabled?: boolean
Expand Down

0 comments on commit 04bd48d

Please sign in to comment.