Skip to content

Commit

Permalink
docs: combobox corrections (#317)
Browse files Browse the repository at this point in the history
  • Loading branch information
huntabyte authored Feb 10, 2024
1 parent 28d7342 commit 5659e52
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions src/content/api-reference/combobox.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import type * as Combobox from "$lib/bits/combobox/_types.js";

export const root: APISchema<Combobox.Props> = {
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,
Expand Down Expand Up @@ -118,7 +118,7 @@ export const root: APISchema<Combobox.Props> = {

export const content: APISchema<Combobox.ContentProps> = {
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: [
Expand All @@ -135,11 +135,11 @@ export const item: APISchema<Combobox.ItemProps> = {
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,
Expand Down Expand Up @@ -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<Combobox.InputProps> = {
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"),
Expand Down Expand Up @@ -237,7 +237,7 @@ export const indicator: APISchema<Combobox.IndicatorProps> = {

export const arrow: APISchema<Combobox.ArrowProps> = {
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: [
Expand Down

0 comments on commit 5659e52

Please sign in to comment.