@pzerelles/headlessui-svelte 2.0.0-next.1 → 2.1.2-next.10

package/dist/test-utils/accessability-assertions.d.ts

@@ -0,0 +1,271 @@
+export declare function getLabel(): HTMLElement | null;
+export declare function getLabels(): HTMLElement[];
+export declare function getDescription(): HTMLElement | null;
+export declare function getDescriptions(): HTMLElement[];
+export declare function getControl(): HTMLElement | null;
+export declare function getInput(): HTMLElement | null;
+export declare function getSelect(): HTMLElement | null;
+export declare function getTextarea(): HTMLElement | null;
+export declare function getCheckbox(): HTMLElement | null;
+export declare enum CheckboxState {
+    /** The checkbox is checked. */
+    Checked = 0,
+    /** The checkbox is unchecked. */
+    Unchecked = 1,
+    /** The checkbox is indeterminate. */
+    Indeterminate = 2
+}
+export declare function assertCheckbox(options: {
+    attributes?: Record<string, string | null>;
+    state: CheckboxState;
+}, checkbox?: HTMLElement | null): void;
+export declare function assertLinkedWithLabel(element: HTMLElement | null, label: HTMLElement | HTMLElement[]): void;
+export declare function assertNotLinkedWithLabel(element: HTMLElement | null, label: HTMLElement | HTMLElement[]): void;
+export declare function assertLinkedWithDescription(element: HTMLElement | null, description: HTMLElement | HTMLElement[]): void;
+export declare function getMenuButton(): HTMLElement | null;
+export declare function getMenuButtons(): HTMLElement[];
+export declare function getMenu(): HTMLElement | null;
+export declare function getMenus(): HTMLElement[];
+export declare function getMenuItems(): HTMLElement[];
+export declare enum MenuState {
+    /** The menu is visible to the user. */
+    Visible = 0,
+    /** The menu is **not** visible to the user. It's still in the DOM, but it is hidden. */
+    InvisibleHidden = 1,
+    /** The menu is **not** visible to the user. It's not in the DOM, it is unmounted. */
+    InvisibleUnmounted = 2
+}
+export declare function assertMenuButton(options: {
+    attributes?: Record<string, string | null>;
+    textContent?: string;
+    state: MenuState;
+}, button?: HTMLElement | null): void;
+export declare function assertMenuButtonLinkedWithMenu(button?: HTMLElement | null, menu?: HTMLElement | null): void;
+export declare function assertMenuLinkedWithMenuItem(item: HTMLElement | null, menu?: HTMLElement | null): void;
+export declare function assertNoActiveMenuItem(menu?: HTMLElement | null): void;
+export declare function assertMenu(options: {
+    attributes?: Record<string, string | null>;
+    textContent?: string;
+    state: MenuState;
+}, menu?: HTMLElement | null): void;
+export declare function assertMenuItem(item: HTMLElement | null, options?: {
+    tag?: string;
+    attributes?: Record<string, string | null>;
+}): void;
+export declare function getComboboxLabel(): HTMLElement | null;
+export declare function getComboboxButton(): HTMLElement | null;
+export declare function getComboboxButtons(): HTMLElement[];
+export declare function getComboboxInput(): HTMLInputElement | null;
+export declare function getCombobox(): HTMLElement | null;
+export declare function getComboboxInputs(): HTMLElement[];
+export declare function getComboboxes(): HTMLElement[];
+export declare function getComboboxOptions(): HTMLElement[];
+export declare enum ComboboxState {
+    /** The combobox is visible to the user. */
+    Visible = 0,
+    /** The combobox is **not** visible to the user. It's still in the DOM, but it is hidden. */
+    InvisibleHidden = 1,
+    /** The combobox is **not** visible to the user. It's not in the DOM, it is unmounted. */
+    InvisibleUnmounted = 2
+}
+export declare enum ComboboxMode {
+    /** The combobox is in the `single` mode. */
+    Single = 0,
+    /** The combobox is in the `multiple` mode. */
+    Multiple = 1
+}
+export declare function assertCombobox(options: {
+    attributes?: Record<string, string | null>;
+    textContent?: string;
+    state: ComboboxState;
+    mode?: ComboboxMode;
+}, combobox?: HTMLInputElement | null, listbox?: HTMLElement | null): void;
+export declare function assertComboboxInput(options: {
+    attributes?: Record<string, string | null>;
+    state: ComboboxState;
+}, input?: HTMLInputElement | null): void;
+export declare function assertComboboxList(options: {
+    attributes?: Record<string, string | null>;
+    textContent?: string;
+    state: ComboboxState;
+}, listbox?: HTMLElement | null): void;
+export declare function assertComboboxButton(options: {
+    attributes?: Record<string, string | null>;
+    textContent?: string;
+    state: ComboboxState;
+}, button?: HTMLElement | null): void;
+export declare function assertComboboxLabel(options: {
+    attributes?: Record<string, string | null>;
+    tag?: string;
+    textContent?: string;
+}, label?: HTMLElement | null): void;
+export declare function assertComboboxButtonLinkedWithCombobox(button?: HTMLElement | null, combobox?: HTMLElement | null): void;
+export declare function assertComboboxLabelLinkedWithCombobox(label?: HTMLElement | null, combobox?: HTMLInputElement | null): void;
+export declare function assertComboboxButtonLinkedWithComboboxLabel(button?: HTMLElement | null, label?: HTMLElement | null): void;
+export declare function assertActiveComboboxOption(item: HTMLElement | null, combobox?: HTMLInputElement | null): void;
+export declare function assertNotActiveComboboxOption(item: HTMLElement | null, combobox?: HTMLInputElement | null): void;
+export declare function assertNoActiveComboboxOption(combobox?: HTMLInputElement | null): void;
+export declare function assertNoSelectedComboboxOption(items?: HTMLElement[]): void;
+export declare function assertComboboxOption(item: HTMLElement | null, options?: {
+    tag?: string;
+    attributes?: Record<string, string | null>;
+    selected?: boolean;
+}): void;
+export declare function getListboxLabel(): HTMLElement | null;
+export declare function getListboxButton(): HTMLElement | null;
+export declare function getListboxButtons(): HTMLElement[];
+export declare function getListbox(): HTMLElement | null;
+export declare function getListboxes(): HTMLElement[];
+export declare function getListboxOptions(): HTMLElement[];
+export declare enum ListboxState {
+    /** The listbox is visible to the user. */
+    Visible = 0,
+    /** The listbox is **not** visible to the user. It's still in the DOM, but it is hidden. */
+    InvisibleHidden = 1,
+    /** The listbox is **not** visible to the user. It's not in the DOM, it is unmounted. */
+    InvisibleUnmounted = 2
+}
+export declare enum ListboxMode {
+    /** The listbox is in the `single` mode. */
+    Single = 0,
+    /** The listbox is in the `multiple` mode. */
+    Multiple = 1
+}
+export declare function assertListbox(options: {
+    attributes?: Record<string, string | null>;
+    textContent?: string;
+    state: ListboxState;
+    mode?: ListboxMode;
+    orientation?: "horizontal" | "vertical";
+}, listbox?: HTMLElement | null): void;
+export declare function assertListboxButton(options: {
+    attributes?: Record<string, string | null>;
+    textContent?: string;
+    state: ListboxState;
+}, button?: HTMLElement | null): void;
+export declare function assertListboxLabel(options: {
+    attributes?: Record<string, string | null>;
+    tag?: string;
+    textContent?: string;
+}, label?: HTMLElement | null): void;
+export declare function assertListboxButtonLinkedWithListbox(button?: HTMLElement | null, listbox?: HTMLElement | null): void;
+export declare function assertListboxLabelLinkedWithListbox(label?: HTMLElement | null, listbox?: HTMLElement | null): void;
+export declare function assertListboxButtonLinkedWithListboxLabel(button?: HTMLElement | null, label?: HTMLElement | null): void;
+export declare function assertActiveListboxOption(item: HTMLElement | null, listbox?: HTMLElement | null): void;
+export declare function assertNoActiveListboxOption(listbox?: HTMLElement | null): void;
+export declare function assertNoSelectedListboxOption(items?: HTMLElement[]): void;
+export declare function assertListboxOption(item: HTMLElement | null, options?: {
+    tag?: string;
+    attributes?: Record<string, string | null>;
+    selected?: boolean;
+}): void;
+export declare function getSwitch(): HTMLElement | null;
+export declare function getSwitchLabel(): HTMLElement | null;
+export declare enum SwitchState {
+    On = 0,
+    Off = 1
+}
+export declare function assertSwitch(options: {
+    state: SwitchState;
+    tag?: string;
+    textContent?: string;
+    label?: string;
+    description?: string;
+    attributes?: Record<string, string | null>;
+}, switchElement?: HTMLElement | null): void;
+export declare function getDisclosureButton(): HTMLElement | null;
+export declare function getDisclosurePanel(): HTMLElement | null;
+export declare enum DisclosureState {
+    /** The disclosure is visible to the user. */
+    Visible = 0,
+    /** The disclosure is **not** visible to the user. It's still in the DOM, but it is hidden. */
+    InvisibleHidden = 1,
+    /** The disclosure is **not** visible to the user. It's not in the DOM, it is unmounted. */
+    InvisibleUnmounted = 2
+}
+export declare function assertDisclosureButton(options: {
+    attributes?: Record<string, string | null>;
+    textContent?: string;
+    state: DisclosureState;
+}, button?: HTMLElement | null): void;
+export declare function assertDisclosurePanel(options: {
+    attributes?: Record<string, string | null>;
+    textContent?: string;
+    state: DisclosureState;
+}, panel?: HTMLElement | null): void;
+export declare function getPopoverButton(): HTMLElement | null;
+export declare function getPopoverPanel(): HTMLElement | null;
+export declare function getPopoverOverlay(): HTMLElement | null;
+export declare enum PopoverState {
+    /** The popover is visible to the user. */
+    Visible = 0,
+    /** The popover is **not** visible to the user. It's still in the DOM, but it is hidden. */
+    InvisibleHidden = 1,
+    /** The popover is **not** visible to the user. It's not in the DOM, it is unmounted. */
+    InvisibleUnmounted = 2
+}
+export declare function assertPopoverButton(options: {
+    attributes?: Record<string, string | null>;
+    textContent?: string;
+    state: PopoverState;
+}, button?: HTMLElement | null): void;
+export declare function assertPopoverPanel(options: {
+    attributes?: Record<string, string | null>;
+    textContent?: string;
+    state: PopoverState;
+}, panel?: HTMLElement | null): void;
+export declare function assertLabelValue(element: HTMLElement | null, value: string): void;
+export declare function assertDescriptionValue(element: HTMLElement | null, value: string): void;
+export declare function getDialog(): HTMLElement | null;
+export declare function getDialogs(): HTMLElement[];
+export declare function getDialogTitle(): HTMLElement | null;
+export declare function getDialogDescription(): HTMLElement | null;
+export declare enum DialogState {
+    /** The dialog is visible to the user. */
+    Visible = 0,
+    /** The dialog is **not** visible to the user. It's still in the DOM, but it is hidden. */
+    InvisibleHidden = 1,
+    /** The dialog is **not** visible to the user. It's not in the DOM, it is unmounted. */
+    InvisibleUnmounted = 2
+}
+export declare function assertDialog(options: {
+    attributes?: Record<string, string | null>;
+    textContent?: string;
+    state: DialogState;
+}, dialog?: HTMLElement | null): void;
+export declare function assertDialogTitle(options: {
+    attributes?: Record<string, string | null>;
+    textContent?: string;
+    state: DialogState;
+}, title?: HTMLElement | null, dialog?: HTMLElement | null): void;
+export declare function assertDialogDescription(options: {
+    attributes?: Record<string, string | null>;
+    textContent?: string;
+    state: DialogState;
+}, description?: HTMLElement | null, dialog?: HTMLElement | null): void;
+export declare function getRadioGroup(): HTMLElement | null;
+export declare function getRadioGroupLabel(): HTMLElement | null;
+export declare function getRadioGroupOptions(): HTMLElement[];
+export declare function assertRadioGroupLabel(options: {
+    attributes?: Record<string, string | null>;
+    textContent?: string;
+}, label?: HTMLElement | null, radioGroup?: HTMLElement | null): void;
+export declare function getTabList(): HTMLElement | null;
+export declare function getTabs(): HTMLElement[];
+export declare function getPanels(): HTMLElement[];
+export declare function assertTabs({ active, orientation, tabContents, panelContents, }: {
+    active: number;
+    orientation?: "vertical" | "horizontal";
+    tabContents?: string | null;
+    panelContents?: string | null;
+}, list?: HTMLElement | null, tabs?: HTMLElement[], panels?: HTMLElement[]): void;
+export declare function assertActiveElement(element: HTMLElement | null): void;
+export declare function assertContainsActiveElement(element: HTMLElement | null): void;
+export declare function assertHidden(element: HTMLElement | null): void;
+export declare function assertVisible(element: HTMLElement | null): void;
+export declare function assertFocusable(element: HTMLElement | null): void;
+export declare function assertNotFocusable(element: HTMLElement | null): void;
+export declare function assertInert(element: HTMLElement | null): void;
+export declare function assertNotInert(element: HTMLElement | null): void;
+export declare function assertDisabledish(element: HTMLElement | null): void;
+export declare function getByText(text: string): HTMLElement | null;