From 5659e52bc01335c16f266ad493c25a75159dc4ab Mon Sep 17 00:00:00 2001 From: Hunter Johnston <64506580+huntabyte@users.noreply.github.com> Date: Sat, 10 Feb 2024 13:51:13 -0500 Subject: [PATCH] docs: combobox corrections (#317) --- src/content/api-reference/combobox.ts | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/src/content/api-reference/combobox.ts b/src/content/api-reference/combobox.ts index 565a799cd..11dee7584 100644 --- a/src/content/api-reference/combobox.ts +++ b/src/content/api-reference/combobox.ts @@ -17,7 +17,7 @@ import type * as Combobox from "$lib/bits/combobox/_types.js"; export const root: APISchema = { title: "Root", - description: "The root combobox component which manages & scopes the state of the select.", + description: "The root combobox component which manages & scopes the state of the combobox.", props: { disabled: { default: C.FALSE, @@ -118,7 +118,7 @@ export const root: APISchema = { export const content: APISchema = { title: "Content", - description: "The element which contains the combobox menu's items.", + description: "The element which contains the combobox's items.", props: { ...transitionProps, ...floatingPositioning, ...domElProps("HTMLDivElement") }, slotProps: { ...builderAndAttrsSlotProps }, dataAttributes: [ @@ -135,11 +135,11 @@ export const item: APISchema = { props: { label: { type: C.STRING, - description: "The label of the select item, which is displayed in the menu.", + description: "The label of the item, which is displayed in the menu.", }, value: { type: C.UNKNOWN, - description: "The value of the select item.", + description: "The value of the item.", }, disabled: { type: C.BOOLEAN, @@ -188,14 +188,14 @@ export const input: APISchema = { }, dataAttributes: [ { - name: "select-input", + name: "combobox-input", description: "Present on the input element.", }, ], }; export const hiddenInput: APISchema = { - title: "hidden-input", + title: "HiddenInput", description: "A hidden input element which is used to store the combobox menu's value, used for form submission. It receives the same value as the `Select.Value` component and can receive any props that a normal input element can receive.", props: domElProps("HTMLInputElement"), @@ -237,7 +237,7 @@ export const indicator: APISchema = { export const arrow: APISchema = { title: "Arrow", - description: "An optional arrow element which points to the selected item when menu open.", + description: "An optional arrow element which points to the content when open.", props: arrowProps, slotProps: { ...builderAndAttrsSlotProps }, dataAttributes: [