Junior Garcia cfea6f02b0
v2.7.0 (#4835)
* chore: org name change (#4596)

* chore: update brand name (#4600)

* fix(calendar): function components cannot be given refs (#4614)

* docs(modal): fix small typos and add clarifying language (#4629)

* chore(deps): bump RA versions (#4611)

* chore(deps): bump RA versions

* chore(deps): bump @internationalized/date

* chore(docs): update RA versions

* chore(docs): update versions

* chore(docs): use string type

* chore(deps): update @react-types versions

* refactor(docs): undo version change since they will be removed in another PR

* feat: tailwind variants upgrade (#4386)

* feat: tailwind variants upgrade

* chore: restore npmrc

* chore: adjust pkgs

* fix: versions

* fix: lock file

* chore(changeset): update package name

* chore(deps): use fixed version

* fix(test): incorrect package name

---------

Co-authored-by: աӄա <wingkwong.code@gmail.com>

* feat: add fn win alt keys (#4638)

* feat: add new keys

* feat: add new keys

* chore: update docs & storybook as well

---------

Co-authored-by: WK Wong <wingkwong.code@gmail.com>

* fix(use-image): load images after props change (#4523)

* fix(use-image): load image after props change

* chore(changeset): add changeset

* refactor(use-image): remove unused props

* feat(use-image): add test case

* fix(use-image): apply useCallback to load & remove status check

* chore(changeset): update package name

* feat: global labelPlacement prop (#4346)

* feat: adding the support for labelPlacement globally

* chore: reafctoring

* chore: updating the dependency

* chore(changeset): update package name

* chore: adding Marcus's suggestions

---------

Co-authored-by: աӄա <wingkwong.code@gmail.com>

* fix(form): use native as default validation behavior (#4425)

* fix(form): use native as default validation behavior

* docs(form): delete explicit validationBehavior=native

* test(form): adjusted form test validation behaviors

* chore(form): adjusted stories with forms

* chore(changeset): changed form default validation behavior to native

* chore(changeset): removed packages with only test changes

* chore(changeset): change to patch

* chore(changeset): update package name

* refactor(docs): update package name

* refactor(docs): update to heroui

---------

Co-authored-by: աӄա <wingkwong.code@gmail.com>

* feat(spinner): new spinner variants (#4555)

* refactor(spinner): add default variant

* feature(spinner): add gradient variant

* feature(spinner): add dots variant

* feature(spinner): add dots-blink variant

* feature(spinner): add spinner-bars

* chore(spinner): add variants storybook

* chore: adding variants to docs

* chore: simplyfying the styles and modifying docs

* chore: nits

* chore: updating the dots and dots-blink animation

* chore: nits

* chore: adding Marcus' suggestions

* chore: adding Marcus's suggestions

* chore: adding junior's suggestions

---------

Co-authored-by: Maharshi Alpesh <maharshialpesh@gmail.com>

* fix: rename wrapper to tab wrapper (#4636)

* fix: rename wrapper to tab wrapper

* docs: update

* docs: update

* docs: update

* fix: rename wrapper to tab wrapper

* refactor: remove feature request from issue template (#4661)

* refactor(.github): remove feature request template

* refactor(.github): add a link to redirect to discussion (feature request category)

* docs(table): include TS examples to show Selection type usage (#4793)

* fix(listbox): unexpected scrollShadow on virtualized listbox (#4784)

* fix(listbox): add scroll height & scroll top to listbox

* fix(use-data-scroll-overflow): handle scrollHeight & scrollTop in virtualization

* chore(changeset): add changeset

* refactor(theme): replace left & right by start & end to support RTL (#4782)

* fix(date-picker): deprecate dateInputClassNames (#4780)

* chore(date-picker): add missing slots comments

* fix(date-picker): remove dateInputClassNames

* fix(date-picker): use classNames instead of dateInputClassNames

* chore(docs): add missing attributes

* fix(date-picker): use classNames instead of dateInputClassNames

* feat(changeset): add changeset

* fix(docs): broken type

* refactor(navbar): remove dropdown menu width (#4757)

* refactor: remove dropdown menu width

* refactor: shorter description

* refactor: rename instances of NextUI to Hero UI (#4645)

* docs: use the correct org for `img.shields.io` license in README

* docs: update opencollective org name

* docs: use correct org name in site footer

* docs: update image urls for heroui pro sections

* docs: update laravel installation keywords in route config

* docs: add `heroui` tag to `Introducing HeroUI` blog post

* fix: use correct names in `plop/components/src` templates

* chore: add empty changeset

* fix: revert image urls back to `nextuipro.nyc3.cdn.digitaloceanspaces...`

* chore: undo footer change

* chore: update incorrect brand name

* chore(docs): nextui -> heroui

---------

Co-authored-by: աӄա <wingkwong.code@gmail.com>

* fix(input): missing clear button with file input type (#4599)

* fix(theme): sync with input theme on labelPlacement (#4597)

* fix(theme): sync with input theme on labelPlacement

* chore(select): revise width for labelPlacement

* chore(changeset): add changeset

* test(input): input interaction tests (#4579)

* test(input): user interaction tests

* test(input): missing act wrappers

---------

Co-authored-by: WK Wong <wingkwong.code@gmail.com>

* fix(calendar): rtl navigation (#4565)

* fix(calendar): rtl navigation

* chore(changeset): fixed reverse behavior of NextButton and PrevButton in the RTL calendar

* chore(changeset): update package name

* refactor(calendar): prefer isRTL and use className in theme package instead

* chore(changeset): add theme package as well

* chore(calendar): add min theme package to 2.4.7

---------

Co-authored-by: աӄա <wingkwong.code@gmail.com>

* refactor: remove unnecessary className passing to tv and make naming consistent (#4558)

* refactor: remove unnecessary className passing to tv

* refactor(button): move styles to getButtonProps

* refactor: rename classNames to styles to keep the naming consistent

* fix: deprecation warning triggered by internal onClick  (#4557)

* fix(use-aria-link): onClick deprecation warning

* fix(use-aria-button): onClick deprecation warning

* feat(changeset): add changeset

* fix(use-aria-button): incorrect prop name

* chore(changeset): update package name

* ci: add pkg pr new (#4540)

* ci: add pkg pr new

* ci: add pkg pr new

* chore(workflow): update repo name

---------

Co-authored-by: աӄա <wingkwong.code@gmail.com>

* chore(docs): remove shouldBlockScroll prop in Tooltip page (#4539)

* fix(use-pagination): controlled page after delay (#4536)

* fix(use-pagination): add page to dependency for scrollTo

* feat(changeset): add changeset

* chore(changeset): update package name

* fix(tooltip): accessing element.ref was removed in React 19 issue (#4531)

* fix(tooltip): accessing element.ref was removed in React 19 issue

* chore(changeset): update package name

* fix: correctly dismissable default value (#4524)

* fix: correctly dismissable default value

* fix: correctly dismissable default value

* chore(changeset): update package name

---------

Co-authored-by: աӄա <wingkwong.code@gmail.com>

* fix(theme): input height in innerWrapper in Select (#4512)

* fix(select): fix input height #4321

* chore(select): changed package name in changeset to theme

* chore(select): updated changeset message

* chore(changeset): update package name

---------

Co-authored-by: աӄա <wingkwong.code@gmail.com>

* fix: inert value in next15 (#4491)

* feat: add post install

* feat: add postinstall

* feat: add postinstall

* fix: type

* fix: type

* fix: next version

* chore(changeset): update package name

---------

Co-authored-by: աӄա <wingkwong.code@gmail.com>

* refactor: remove cursor-hit in hiddenInputClasses (#4474)

* refactor: remove cursor-hit in hiddenInputClasses

* Create lazy-ants-exercise.md

* chore(changeset): update package name

---------

Co-authored-by: աӄա <wingkwong.code@gmail.com>

* feat(table): virtualization (#4285)

* feat: baseline virtualization for table

* merge branch canary

* fix: table layout

* fix: calc header height w layouteffect to offset padding

* Merge branch 'canary' into feat/eng-1633-virtualization-for-table

* chore: remove unused files and comments

* chore: add missing package

* feat: add shouldVirtualize conditional to render virtualized-table

* feat: update docs for table

* feat: use wrapper to support theme styles

* chore: add changeset

* chore(changeset): update package name

* chore(deps): pnpm-lock.yaml

* fix(table): outdated package name

* chore(changeset): add issue number

* fix(deps): keep the version consistent with other components

* fix(table): incorrect displayName

* refactor(table): use VirtualizedTemplate

* chore(deps): bump `@tanstack/react-virtua`

* chore(deps): typecheck issue

* fix(table): do not use any type

* chore: remove auto virtualization

---------

Co-authored-by: աӄա <wingkwong.code@gmail.com>
Co-authored-by: Junior Garcia <jrgarciadev@gmail.com>

* feat(toast): introduce Toast component (#4437)

* feat: initial commit

* chore: adding the animation

* chore: nits

* chore: fixes and adding draft1 of stories

* chore: adding the docs draft

* chore: adding the swiping interaction for toast removal

* chore: adding the tests

* fix: improving the progress bar logix

* chore: refactoring and refining the animations

* fix: making the animations compatible with the positons

* chore: fixing the styles

* chore: modifying the animations

* chore: improving the animations

* chore: adding the decorator to the story-book

* chore: fixing the animations and positions

* fix: handle expand region on touch

* feat: adding the promises support

* chore: updating the styles

* chore: improving styles

* chore: styles correction

* fix: adding junior's suggestions

* chore: correcting styles

* fix: fixing the timer behavior

* chore: adding the spinner to the toast

* chore: full width for mobile

* chore: modifying styles

* chore: fixing the positions on smaller devices

* chore: adding story with description

* chore: adding credits for sonner

* fix: adding junior's suggestions

* chore: adding the exit animation

* fix: adding junior's suggestions

* chore: improving the swipe animations

* fix: fixing the swipe animations on touch

* chore: adding tests

* chore: adding swipe threshild and initial position variable

* fix: fixing autoclose in timeout

* chore: modifying the docs

* chore: fixing the conflict

* chore: adding marcus' suggestions

* chore: adding the bottom animations

* chore: modying docs

* chore: removing nextui references

* chore: adding info about the provider

* chore: updating the docs

* chore: versions in package.json

* chore: nits

* chore: adding junior's suggestions

* chore: nits

* fix: applying junior's suggestions

* chore: adding junior's suggestions

* chore: using domMax

* fix: adding Marcus's suggestions

* chore: add global toast props and custom close icon

* chore: adding the defaultTimout provider prop

* chore: modifying defaultTimeout

* chore: nits

* fix: adding Marcus' suggestions

* chore: fixing bg

* chore(deps): bump RA deps

* fix: fixing the color discrepancy due to the timer

* chore: moving the kapan ai to the left side

* refactor(toast): update author

* chore: nit

* chore: improvements

* chore: updating the solid variant

---------

Co-authored-by: Junior Garcia <jrgarciadev@gmail.com>
Co-authored-by: WK Wong <wingkwong.code@gmail.com>

* fix(docs): correct Tab usage example (#4821)

* chore(docs): add note itemHeight for virtualization (#4822)

* chore(docs): add note itemHeight for virtualization

* fix: format

* fix(docs): fix horizontal scrolling example in scroll-shadow (#4820)

* refactor: update author in package.json (#4800)

* feat(button): export PressEvent for onPress event typing   (#4819)

* fix(docs): failed to install dependencies in StackBlitz (#4639)

* chore(Docs): remove step 2 from "Using use-theme-hook" (#4797)

* fix(docs): incorrect code Modal placement (#4652)

* docs: update DatePicker example to remove "time" label as time selection is not supported in this example (#4443)

* feat(button): export PressEvent for onPress event typing

* revert unnecessary changes

* chore: format

---------

Co-authored-by: աӄա <wingkwong.code@gmail.com>
Co-authored-by: Praharsh Bhatt <30700808+praharshbhatt@users.noreply.github.com>

* fix(listbox): pass missing press events to usePress (#4812)

* fix(listbox): pass missing press events to usePress

* feat(listbox): add test case for press event

* chore(changeset): add changeset

* fix(checkbox): inherit stroke in CheckboxIcon (#4811)

* fix: `SelectItem`, `ListboxItem`, and `AutocompleteItem` not to accept `value` props (#4653)

* fix(select): `SelectItem` does not accept value props

* refactor: do not use the index as `key`

* Update .changeset/light-hairs-draw.md

* chore: remove unnecessary `value` props

* chore: update changeset

* refactor: remove unnecessary value prop

---------

Co-authored-by: WK Wong <wingkwong.code@gmail.com>

* fix: pkg package scope (#4823)

* fix: pkg package scope

* fix: pkg package scope

* fix: pkg package scope

* fix(theme): border radius in Table when isMultiSelectable (#4808)

* fix(theme): border radius in Table when isMultiSelectable

* chore(theme): added changeset (#4807)

* chore: removing the kapa ai for toast doc page (#4833)

* fix(accordion): add data-slot attributes to accordion (#4832)

* fix(accordion): add data-slot attributes to accordion

* chore

---------

Co-authored-by: Hovannes Markarian <hovannes.markarian@socrate.fr>
Co-authored-by: աӄա <wingkwong.code@gmail.com>

* chore(docs): update versions (#4836)

* docs(themes): adding theme generator (#4626)

* chore: adding xylish's contributions + modifying styles

* chore: nextui to heroui

* chore: colors in theme generator

* chore: radiuses, disable-opacity

* chore: fixing the configuration box styles

* chore: adding the showcase elemtents

* chore: modifying styles

* chore: adding the fonts

* chore: adding the scaling

* chore: removing the calendar

* feat: adding the border-width

* chore: modifying style for mobile

* chore: modifying the styles

* chore: removing the NextUI references + small bug fix

* chore: adding coderabits reviews

* fix: borderWidth not getting applied on breadcrumbs and input

* chore: rebasing

* chore: modifying the styles

* chore: updating the styles for the smaller devices

* chore: refactoring

* chore: improvements

* chore: making the fonts workable

* chore: making the fonts workable

* chore: modifying the swatch according to the theme

* chore: adding the default selected template

* chore: modifying mobile styles

* chore: fixing the popover

* chore: nit

* fix: fixing the select styles

* chore: modifying the mobile styles

* chore: modifying the styles

* fix: adding junior's suggestions

* fix: fixing the breadcrumb

* fix: adding junior's suggestions

* feat: introduce NumberInput (#4475)

* feat(number-field): init structure

* feat(deps): add `@nextui-org/button` & `@react-types/button`

* feat(theme): export number-field

* feat(number-field): storybook init structure

* feat(number-field): add NumberFieldHorizontalStepper

* feat(number-field): add NumberFieldHorizontalStepper

* feat(theme): init number field theme

* feat(number-field): number-field draft

* refactor(number-field): revise stepper icons

* feat(shared-icons): add ChevronLeftIcon

* feat(theme): stepperButton styles

* feat(theme): number-field styles

* fix(number-field): label layout

* feat(number-field): vertical stepper wrapper

* feat(number-field): use-number-field (wip)

* feat(number-field): add data-direction

* feat(theme): center the text if it is horizontal stepper

* feat(number-field): add HorizontalStepper

* feat(number-field): add HideStepper

* chore(number-field): revise minValue & defaultValue

* feat(docs): init number field structure

* fix(theme): outside-left styles

* refactor(theme): remove labelPlacement styles

* refactor(number-field): remove labelContent logic

* refactor(number-field): remove labelPlacement args

* feat(number-field): helper text

* feat(number-field): revise number field stories

* feat(number-field): description

* refactor(number-field): revise number field stories

* feat(theme): numberFieldLabelClasses

* fix(number-field): incorrect button props

* fix(number-field): typing issue on stepper buttons

* chore(number-field): add aria-label

* refactor(number-field): merge props

* fix(number-field): pass originalProps instead

* chore(number-field): revise Required story args

* feat(number-field): add WithStepValue & WithWheelDisabled & revise stories

* chore(number-field): add label to Required

* feat(docs): number-field doc page

* fix(number-field): typing issue

* fix(number-field): test cases

* fix(number-field): user.keyboard & defaultValue

* fix(number-field): should work with defaultValues

* chore(number-field): add type: number

* chore(number-field): remove hidden related code

* fix(number-field): numeric value

* chore(changeset): add changeset

* feat(deps): add "@nextui-org/number-field" to docs

* feat(react): export `@nextui-org/number-field`

* feat(changeset): add @nextui-org/react

* feat(docs): number-field examples

* chore(number-field): use text instead

* refactor(number-field): remove unnecessary filled-within

* fix(number-field): test case

* chore(number-field): remove aria-label for stepper buttons

* feat(docs): add incrementAriaLabel & decrementAriaLabel to NumberField

* chore(number-field): reorder WithFormatOptions

* fix(deps): update number-field's peerDependencies & dependencies

* feat(number-field): hidden input for holding numeric vaule

* fix(docs): number field title

* feat(docs): add format options to number field

* chore(docs): revise number field content

* chore(number-field): add type to useDOMRef

* fix(number-field): clear button

* fix(theme): clear button styles

* refactor(theme): stepper button styles

* chore(number-field): accept stepperButton class

* fix(theme): helper wrapper padding

* feat(deps): add `@react-aria/i18n`

* fix(number-field): use locale from `@react-aria/i18n`

* fix(deps): dependency order

* fix(docs): incorrect command

* chore(docs): remove type=number

* chore(theme): add padding to stepper wrapper

* fix(number-field): avoid resetting value

* fix(number-field): storybook

* chore(docs): remove custom impl

* chore(docs): update docs code & content

* chore(number-field):  migrate to heroui

* chore(number-field): migrate to heroui

* chore(number-field): migrate to heroui

* chore: rename to number input

* fix(number-input): incorrect import

* chore(docs): rename to number input

* chore: change to number input

* refactor(number-input): change label to amount

* fix(docs): use heroui commands

* chore(changeset): update package name

* refactor(number-input): remove steps

* refactor: remove helper text

* feat(number-input): label placement

* refactor(number-input): rename stepper

* fix(theme): isClearable

* feat(docs): add label placements

* refactor(docs): update number-input content

* fix(docs): incorrect file

* feat(docs): add lablePlacement

* refactor(docs): remove labelPlacement & startContent

* refactor(docs): remove helperText

* refactor(docs): remove helperText

* refactor(docs): revise description

* feat(number-input): add data-slot for stepper-wrapper

* fix(number-input): test cases

* fix(docs): unexpected change

* refactor(number-input): update outdated info

* fix(docs): coderabbitai comments

* refactor: remove validationState

* fix(docs): typo

* chore(deps): remove unnecessary dep

* chore(deps): bump RA versions

* chore(number-input): apply latest labelPlacement change

* refactor(number-input): update author

* refactor(number-input): revise stepper wrapper alignment

* refactor(number-input): stepper button styles

* chore(number-input): add disableRipple

* fix(theme): increase stepper button click area

* fix(number-input): sync latest validationBehavior changes

* fix(number-input): pass validationBehavior to useAriaNumberInput

* chore(docs): add import react

* chore(number-input): remove HorizontalStepper story

* chore(number-input): enable ripple

* fix(number-input): remove number type

* refactor(theme): follow input clear button styles

* feat(theme): add color for stepperButton

* fix(theme): revise stepperButton size for outside & outside-left cases

* fix(number-input): typo

* chore(docs): update description for wheel

* chore(theme): change opacity when pressed

* chore(number-input): add disableRipple

* Update .changeset/witty-flies-reflect.md

* fix(theme): add hover opacity effect

---------

Co-authored-by: Junior Garcia <jrgarciadev@gmail.com>

* chore(docs): revised tags in doc routes for 2.7.0 (#4777)

* chore(docs): remove last version update tags

* chore(docs): add updated tag for 2.7.0

* chore(docs): updated table

* chore(docs): update search meta

* chore(docs): update github info

* Merge branch 'canary' into docs/eng-2003

* chore(docs): update routes.json

* chore(docs): update meta info

* chore: improve theme builder

* v2.7.0

* chore: v2.7.0 combined changeset

* fix: changeset

* fix: peer deps

* feat: toast api improved

* chore: toast styles improved

* fix: toast styles

* chore: toast width style changed

* fix: changeset release

* fix: changeset peerdeps

* chore: toast styles improved

* refactor(pagination): rtl (#4843)

* refactor(pagination): rtl

* chore(changeset): add changeset

* feat: new spinner variant

* fix(docs): popover shouldBlockScroll default value (#4851)

* fix(select): select scroll content will close immediately when popover on click (#4849)

* chore(select): update select deps

* fix(select): select scroll content will close immediately when popover on click

* chore(select): add .changeset file

* chore(changeset): add issue number

---------

Co-authored-by: աӄա <wingkwong.code@gmail.com>

* feat(calendar): add firstDayOfWeek (#4852)

* feat(calendar): add firstDayOfWeek

* feat(docs): add firstDayOfWeek in Calendar docs

* feat(calendar): add firstDayOfWeek to range calendar

* feat(docs): add firstDayOfWeek to API table

* feat: add firstDayOfWeek to date picker & date range picker

* feat(docs): add firstDayOfWeek

* feat(changeset): add changeset

* feat: add firstDayOfWeek option in storybook

* feat(docs): export firstDayOfWeek

* chore(docs): update title

* chore: spinner variants updated

* feat: v2.7.0 blog

* ci(changesets): version packages (#4601)

Co-authored-by: Junior Garcia <jrgarciadev@gmail.com>

* chore: manual release

---------

Co-authored-by: աӄա <wingkwong.code@gmail.com>
Co-authored-by: millmason <jmsoper@protonmail.com>
Co-authored-by: winches <329487092@qq.com>
Co-authored-by: Maharshi Alpesh <maharshialpesh@gmail.com>
Co-authored-by: Peterl561 <76144929+Peterl561@users.noreply.github.com>
Co-authored-by: Paul Ebose <49006567+plbstl@users.noreply.github.com>
Co-authored-by: Zarin <thesharifi.maruf@gmail.com>
Co-authored-by: Shrinidhi Upadhyaya <shrinidhiupadhyaya1195@gmail.com>
Co-authored-by: Avan <layouwen@gmail.com>
Co-authored-by: Vincentius Roger Kuswara <vincentiusrkuswara@gmail.com>
Co-authored-by: Ryo Matsukawa <76232929+ryo-manba@users.noreply.github.com>
Co-authored-by: Praharsh Bhatt <30700808+praharshbhatt@users.noreply.github.com>
Co-authored-by: Adrian Szarapow <63786007+Adee1499@users.noreply.github.com>
Co-authored-by: Hova25 <75216176+Hova25@users.noreply.github.com>
Co-authored-by: Hovannes Markarian <hovannes.markarian@socrate.fr>
Co-authored-by: Tsuki <76603360+sudongyuer@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2025-02-18 18:06:37 -03:00

1528 lines
44 KiB
TypeScript

import type {SelectProps} from "../src";
import "@testing-library/jest-dom";
import * as React from "react";
import {render, renderHook, waitFor, act} from "@testing-library/react";
import userEvent, {UserEvent} from "@testing-library/user-event";
import {spy, shouldIgnoreReactWarning} from "@heroui/test-utils";
import {useForm} from "react-hook-form";
import {Form} from "@heroui/form";
import {Select, SelectItem, SelectSection} from "../src";
import {Modal, ModalContent, ModalHeader, ModalBody, ModalFooter} from "../../modal/src";
type Item = {
label: string;
id: string;
};
const itemsData: Item[] = [
{label: "Cat", id: "cat"},
{label: "Dog", id: "dog"},
{label: "Elephant", id: "elephant"},
{label: "Lion", id: "lion"},
{label: "Tiger", id: "tiger"},
{label: "Giraffe", id: "giraffe"},
{label: "Dolphin", id: "dolphin"},
{label: "Penguin", id: "penguin"},
{label: "Zebra", id: "zebra"},
{label: "Shark", id: "shark"},
{label: "Whale", id: "whale"},
{label: "Otter", id: "otter"},
{label: "Crocodile", id: "crocodile"},
];
const itemsSectionData = [
{
key: "mammals",
title: "Mammals",
children: [
{key: "lion", label: "Lion", value: "lion"},
{key: "tiger", label: "Tiger", value: "tiger"},
{key: "elephant", label: "Elephant", value: "elephant"},
],
},
{
key: "birds",
title: "Birds",
children: [
{key: "penguin", label: "Penguin", value: "penguin"},
{key: "ostrich", label: "Ostrich", value: "ostrich"},
{key: "peacock", label: "Peacock", value: "peacock"},
],
},
];
describe("Select", () => {
let user: UserEvent;
beforeEach(() => {
user = userEvent.setup();
});
afterEach(() => {
jest.clearAllMocks();
});
it("should render correctly", () => {
const wrapper = render(
<Select disableAnimation aria-label="Favorite Animal" label="Favorite Animal">
<SelectItem key="penguin">Penguin</SelectItem>
<SelectItem key="zebra">Zebra</SelectItem>
<SelectItem key="shark">Shark</SelectItem>
</Select>,
);
if (shouldIgnoreReactWarning(spy)) {
return;
}
expect(spy).toHaveBeenCalledTimes(0);
expect(() => wrapper.unmount()).not.toThrow();
});
it("ref should be forwarded", () => {
const ref = React.createRef<HTMLSelectElement>();
render(
<Select ref={ref} disableAnimation aria-label="Favorite Animal" label="Favorite Animal">
<SelectItem key="penguin">Penguin</SelectItem>
<SelectItem key="zebra">Zebra</SelectItem>
<SelectItem key="shark">Shark</SelectItem>
</Select>,
);
expect(ref.current).not.toBeNull();
});
it("should render correctly (dynamic)", () => {
const wrapper = render(
<Select
disableAnimation
aria-label="Favorite Animal"
items={itemsData}
label="Favorite Animal"
>
{(item) => <SelectItem key={item.id}>{item.label}</SelectItem>}
</Select>,
);
expect(() => wrapper.unmount()).not.toThrow();
});
it("should render correctly with section (static)", () => {
const wrapper = render(
<Select disableAnimation aria-label="Favorite Animal" label="Favorite Animal">
<SelectSection title="Birds">
<SelectItem key="penguin">Penguin</SelectItem>
</SelectSection>
<SelectSection title="Mammals">
<SelectItem key="zebra">Zebra</SelectItem>
<SelectItem key="shark">Shark</SelectItem>
</SelectSection>
</Select>,
);
expect(() => wrapper.unmount()).not.toThrow();
});
it("should render correctly with section (dynamic)", () => {
const wrapper = render(
<Select
disableAnimation
aria-label="Favorite Animal"
items={itemsSectionData}
label="Favorite Animal"
>
{(section) => (
<SelectSection<(typeof itemsSectionData)[0]["children"][0]>
aria-label={section.title}
items={section.children}
title={section.title}
>
{/* @ts-ignore TODO: fix section children types*/}
{(item: Item) => <SelectItem key={item.value}>{item.label}</SelectItem>}
</SelectSection>
)}
</Select>,
);
expect(() => wrapper.unmount()).not.toThrow();
});
it("should work with single selection (controlled)", async () => {
let onSelectionChange = jest.fn();
const wrapper = render(
<Select
disableAnimation
disallowEmptySelection
isOpen
aria-label="Favorite Animal"
label="Favorite Animal"
selectionMode="single"
onSelectionChange={onSelectionChange}
>
<SelectItem key="penguin">Penguin</SelectItem>
<SelectItem key="zebra">Zebra</SelectItem>
<SelectItem key="shark">Shark</SelectItem>
</Select>,
);
let listbox = wrapper.getByRole("listbox");
expect(listbox).toBeTruthy();
let listboxItems = wrapper.getAllByRole("option");
expect(listboxItems.length).toBe(3);
await user.click(listboxItems[1]);
expect(onSelectionChange).toHaveBeenCalledTimes(1);
});
it("should work with multiple selection (controlled)", async () => {
let onSelectionChange = jest.fn();
const wrapper = render(
<Select
disableAnimation
disallowEmptySelection
isOpen
aria-label="Favorite Animal"
label="Favorite Animal"
selectionMode="multiple"
onSelectionChange={onSelectionChange}
>
<SelectItem key="penguin">Penguin</SelectItem>
<SelectItem key="zebra">Zebra</SelectItem>
<SelectItem key="shark">Shark</SelectItem>
</Select>,
);
let listbox = wrapper.getByRole("listbox");
expect(listbox).toBeTruthy();
let listboxItems = wrapper.getAllByRole("option");
expect(listboxItems.length).toBe(3);
await act(async () => {
await user.click(listboxItems[1]);
await user.click(listboxItems[2]);
});
expect(onSelectionChange).toHaveBeenCalledTimes(2);
});
it("should work with dynamic placeholder and renderValue", async () => {
const SelectWrapper = (props: {
placeholder?: SelectProps["placeholder"];
renderValue?: SelectProps["renderValue"];
}) => {
const {placeholder, renderValue} = props;
return (
<Select
disableAnimation
aria-label="Favorite Animal"
data-testid="render-selected-item-test"
label="Favorite Animal"
placeholder={placeholder}
renderValue={renderValue}
>
<SelectItem key="penguin">Penguin</SelectItem>
<SelectItem key="zebra">Zebra</SelectItem>
<SelectItem key="shark">Shark</SelectItem>
</Select>
);
};
const wrapper = render(<SelectWrapper placeholder="Select an animal" />);
expect(wrapper.getByText("Select an animal")).toBeInTheDocument();
wrapper.rerender(<SelectWrapper placeholder="Select an favorite animal" />);
expect(wrapper.getByText("Select an favorite animal")).toBeInTheDocument();
const select = wrapper.getByTestId("render-selected-item-test");
await act(async () => {
await user.click(select);
});
const listboxItems = wrapper.getAllByRole("option");
await act(async () => {
await user.click(listboxItems[0]);
});
expect(select).toHaveTextContent("Penguin");
expect(wrapper.queryByText("Select an favorite animal")).toBe(null);
wrapper.rerender(
<SelectWrapper
placeholder="Select an favorite animal"
renderValue={(item) => `next ${item[0].textValue}`}
/>,
);
expect(wrapper.getByText("next Penguin")).toBeInTheDocument();
expect(wrapper.queryByText("Select an favorite animal")).toBe(null);
});
it("should close dropdown when clicking outside select", async () => {
const wrapper = render(
<Select
disableAnimation
aria-label="Favorite Animal"
data-testid="close-when-clicking-outside-test"
label="Favorite Animal"
>
<SelectItem key="penguin">Penguin</SelectItem>
<SelectItem key="zebra">Zebra</SelectItem>
<SelectItem key="shark">Shark</SelectItem>
</Select>,
);
const select = wrapper.getByTestId("close-when-clicking-outside-test");
// open the select dropdown
await user.click(select);
// assert that the select is open
expect(select).toHaveAttribute("aria-expanded", "true");
// click outside the select component
await user.click(document.body);
// assert that the select is closed
expect(select).toHaveAttribute("aria-expanded", "false");
});
it("should close dropdown when clicking outside select with modal open", async () => {
const wrapper = render(
<Modal isOpen>
<ModalContent>
<ModalHeader>Modal header</ModalHeader>
<ModalBody>
<Select
disableAnimation
aria-label="Favorite Animal"
data-testid="close-when-clicking-outside-test"
label="Favorite Animal"
>
<SelectItem key="penguin">Penguin</SelectItem>
<SelectItem key="zebra">Zebra</SelectItem>
<SelectItem key="shark">Shark</SelectItem>
</Select>
</ModalBody>
<ModalFooter>Modal footer</ModalFooter>
</ModalContent>
</Modal>,
);
const select = wrapper.getByTestId("close-when-clicking-outside-test");
// open the select dropdown
await user.click(select);
// assert that the select is open
expect(select).toHaveAttribute("aria-expanded", "true");
// click outside the select component
await user.click(document.body);
// assert that the select is closed
expect(select).toHaveAttribute("aria-expanded", "false");
});
it("disabled select shouldn't update by keyboard", async () => {
let onSelectionChange = jest.fn();
const wrapper = render(
<Select
disableAnimation
isDisabled
aria-label="Favorite Animal"
data-testid="test-select"
label="Favorite Animal"
selectionMode="single"
onSelectionChange={onSelectionChange}
>
<SelectItem key="penguin">Penguin</SelectItem>
<SelectItem key="zebra">Zebra</SelectItem>
<SelectItem key="shark">Shark</SelectItem>
</Select>,
);
const select = wrapper.getByTestId("test-select");
await user.click(document.body);
await user.tab();
await user.type(select, "z", {skipClick: true});
expect(onSelectionChange).toHaveBeenCalledTimes(0);
});
it("should pre-select items based on defaultSelectedKeys (numeric keys)", () => {
const items = [
{key: 1, value: "Penguin"},
{key: 2, value: "Zebra"},
{key: 3, value: "Shark"},
];
const wrapper = render(
<Select
disableAnimation
isOpen
defaultSelectedKeys={[1, 2]} // Numeric keys for selection
items={items}
label="Test Default Selected Keys"
selectionMode="multiple"
>
{(item) => <SelectItem>{item.value}</SelectItem>}
</Select>,
);
const selectedOptions = wrapper.getAllByRole("option", {selected: true});
expect(selectedOptions.length).toBe(2);
expect(selectedOptions.map((opt) => opt.textContent)).toEqual(["Penguin", "Zebra"]);
});
it("should pre-select items based on defaultSelectedKeys (numeric ids)", () => {
const items = [
{id: 1, value: "Penguin"},
{id: 2, value: "Zebra"},
{id: 3, value: "Shark"},
];
const wrapper = render(
<Select
disableAnimation
isOpen
defaultSelectedKeys={[1, 2]} // Numeric ids for selection
items={items}
label="Test Default Selected IDs"
selectionMode="multiple"
>
{(item) => <SelectItem>{item.value}</SelectItem>}
</Select>,
);
const selectedOptions = wrapper.getAllByRole("option", {selected: true});
expect(selectedOptions.length).toBe(2);
expect(selectedOptions.map((opt) => opt.textContent)).toEqual(["Penguin", "Zebra"]);
});
it("onSelectionChange should be called with a Set of item ids upon selection", async () => {
const itemsWithId = [
{id: 1, value: "penguin"},
{id: 2, value: "zebra"},
{id: 3, value: "shark"},
];
const onSelectionChangeId = jest.fn();
const wrapperWithId = render(
<Select
disableAnimation
isOpen
items={itemsWithId}
label="Test with ID"
onSelectionChange={onSelectionChangeId}
>
{(item) => <SelectItem>{item.value}</SelectItem>}
</Select>,
);
const listbox = wrapperWithId.getByRole("listbox");
expect(listbox).toBeInTheDocument();
// Select item and check the correct ID is passed to the callback
await user.click(wrapperWithId.getByRole("option", {name: itemsWithId[0].value}));
expect(onSelectionChangeId).toHaveBeenCalled();
let selectionArg = onSelectionChangeId.mock.calls[0][0];
expect([...selectionArg]).toEqual([itemsWithId[0].id]);
await user.click(wrapperWithId.getByRole("option", {name: itemsWithId[1].value}));
expect(onSelectionChangeId).toHaveBeenCalledTimes(2);
selectionArg = onSelectionChangeId.mock.calls[1][0];
expect([...selectionArg]).toEqual([itemsWithId[1].id]);
});
it("onSelectionChange should be called with a Set of item keys upon selection", async () => {
const itemsWithKey = [
{key: 1, value: "penguin"},
{key: 2, value: "zebra"},
{key: 3, value: "shark"},
];
const onSelectionChangeKey = jest.fn();
const wrapperWithKey = render(
<Select
disableAnimation
isOpen
items={itemsWithKey}
label="Test with Key"
onSelectionChange={onSelectionChangeKey}
>
{(item) => <SelectItem>{item.value}</SelectItem>}
</Select>,
);
const listbox = wrapperWithKey.getByRole("listbox");
expect(listbox).toBeInTheDocument();
// Select item and check the correct key is passed to the callback
await user.click(wrapperWithKey.getByRole("option", {name: itemsWithKey[0].value}));
expect(onSelectionChangeKey).toHaveBeenCalled();
let selectionArg = onSelectionChangeKey.mock.calls[0][0];
expect([...selectionArg]).toEqual([itemsWithKey[0].key]);
await user.click(wrapperWithKey.getByRole("option", {name: itemsWithKey[1].value}));
expect(onSelectionChangeKey).toHaveBeenCalledTimes(2);
selectionArg = onSelectionChangeKey.mock.calls[1][0];
expect([...selectionArg]).toEqual([itemsWithKey[1].key]);
});
it("should display selected items as comma-separated string inside the select", async () => {
const wrapper = render(
<Select
disableAnimation
isDisabled
aria-label="Favorite Animal"
data-testid="test-select"
selectedKeys={["penguin", "zebra"]}
selectionMode="multiple"
>
<SelectItem key="penguin">Penguin</SelectItem>
<SelectItem key="zebra">Zebra</SelectItem>
<SelectItem key="shark">Shark</SelectItem>
</Select>,
);
const select = wrapper.getByTestId("test-select");
const displayedText = select?.textContent?.trim();
expect(displayedText).toBe("Penguin, Zebra");
});
it("should close listbox by clicking another select", async () => {
const wrapper = render(
<>
<Select
disableAnimation
aria-label="Favorite Animal"
data-testid="select"
label="Favorite Animal"
>
<SelectItem key="penguin">Penguin</SelectItem>
<SelectItem key="zebra">Zebra</SelectItem>
<SelectItem key="shark">Shark</SelectItem>
</Select>
<Select
disableAnimation
aria-label="Favorite Animal"
data-testid="select2"
label="Favorite Animal"
>
<SelectItem key="penguin">Penguin</SelectItem>
<SelectItem key="zebra">Zebra</SelectItem>
<SelectItem key="shark">Shark</SelectItem>
</Select>
</>,
);
const select = wrapper.getByTestId("select");
const select2 = wrapper.getByTestId("select2");
expect(select).not.toBeNull();
expect(select2).not.toBeNull();
// open the select listbox by clicking selector button in the first select
await user.click(select);
// assert that the first select listbox is open
expect(select).toHaveAttribute("aria-expanded", "true");
// assert that the second select listbox is close
expect(select2).toHaveAttribute("aria-expanded", "false");
// close the select listbox by clicking the second select
await user.click(select2);
// assert that the first select listbox is closed
expect(select).toHaveAttribute("aria-expanded", "false");
// assert that the second select listbox is open
expect(select2).toHaveAttribute("aria-expanded", "true");
});
it("should display placeholder text when unselected", async () => {
const wrapper = render(
<Select
disableAnimation
aria-label="Favorite Animal"
data-testid="test-select"
label="Favorite Animal"
placeholder="Select an animal"
>
<SelectItem key="penguin">Penguin</SelectItem>
<SelectItem key="zebra">Zebra</SelectItem>
<SelectItem key="shark">Shark</SelectItem>
</Select>,
);
const select = wrapper.getByTestId("test-select");
expect(select).toHaveTextContent("Select an animal");
});
it("should display placeholder text when unselected (controlled)", async () => {
const onSelectionChange = jest.fn();
const wrapper = render(
<Select
disableAnimation
isOpen
aria-label="Favorite Animal"
data-testid="test-select"
placeholder="Select an animal"
selectedKeys={[]}
onSelectionChange={onSelectionChange}
>
<SelectItem key="penguin">Penguin</SelectItem>
<SelectItem key="zebra">Zebra</SelectItem>
<SelectItem key="shark">Shark</SelectItem>
</Select>,
);
const select = wrapper.getByTestId("test-select");
expect(select).toHaveTextContent("Select an animal");
});
it("should unset form value", async () => {
const logSpy = jest.spyOn(console, "log");
const wrapper = render(
<form
className="w-full max-w-xs items-end flex flex-col gap-4"
onSubmit={(e) => {
e.preventDefault();
const formData = new FormData(e.target as HTMLFormElement);
/* eslint-disable no-console */
// @ts-ignore
console.log(JSON.stringify(Object.fromEntries(formData)));
}}
>
<Select
disableAnimation
data-testid="select"
defaultSelectedKeys={["foo"]}
label="test select"
name="select"
>
<SelectItem key="foo">foo</SelectItem>
<SelectItem key="bar">bar</SelectItem>
</Select>
<button data-testid="submit-button" type="submit">
Submit
</button>
</form>,
);
const submitButton = wrapper.getByTestId("submit-button");
await user.click(submitButton);
expect(logSpy).toHaveBeenCalledWith(JSON.stringify({select: "foo"}));
const select = wrapper.getByTestId("select");
expect(select).not.toBeNull();
await user.click(select);
const listbox = wrapper.getByRole("listbox");
expect(listbox).toBeTruthy();
const listboxItems = wrapper.getAllByRole("option");
expect(listboxItems.length).toBe(2);
await user.click(listboxItems[0]);
await user.click(submitButton);
expect(logSpy).toHaveBeenCalledWith(JSON.stringify({select: ""}));
});
it("should close listbox by clicking selector button again", async () => {
const wrapper = render(
<Select
disableAnimation
aria-label="Favorite Animal"
data-testid="select"
label="Favorite Animal"
>
<SelectItem key="penguin">Penguin</SelectItem>
<SelectItem key="zebra">Zebra</SelectItem>
<SelectItem key="shark">Shark</SelectItem>
</Select>,
);
const select = await wrapper.findByTestId("select");
expect(select).not.toBeNull();
// open the select listbox by clicking selector button
await user.click(select);
// assert that the select listbox is open
expect(select).toHaveAttribute("aria-expanded", "true");
// open the select listbox by clicking selector button
await user.click(select);
// assert that the select listbox is closed
expect(select).toHaveAttribute("aria-expanded", "false");
});
it("should work with onChange (< 300 select items)", async () => {
const onChange = jest.fn();
let options = new Array(10).fill("");
options = options.map((_, i) => {
return `option ${i}`;
});
const wrapper = render(
<Select
disableAnimation
isOpen
aria-label="Favorite Animal"
isVirtualized={false}
label="Favorite Animal"
onChange={onChange}
>
{options.map((o) => (
<SelectItem key={o}>{o}</SelectItem>
))}
</Select>,
);
let listbox = wrapper.getByRole("listbox");
expect(listbox).toBeTruthy();
let listboxItems = wrapper.getAllByRole("option");
expect(listboxItems.length).toBe(10);
await user.click(listboxItems[1]);
expect(onChange).toHaveBeenCalledTimes(1);
});
it("should work with onChange (>= 300 select items)", async () => {
let onChange = jest.fn();
let options = new Array(300).fill("");
options = options.map((_, i) => {
return `option ${i}`;
});
const wrapper = render(
<Select
disableAnimation
isOpen
aria-label="Favorite Animal"
isVirtualized={false}
label="Favorite Animal"
onChange={onChange}
>
{options.map((o) => (
<SelectItem key={o}>{o}</SelectItem>
))}
</Select>,
);
let listbox = wrapper.getByRole("listbox");
expect(listbox).toBeTruthy();
let listboxItems = wrapper.getAllByRole("option");
expect(listboxItems.length).toBe(300);
await user.click(listboxItems[1]);
expect(onChange).toHaveBeenCalledTimes(1);
});
it("should place the label outside when labelPlacement is outside and isMultiline enabled", () => {
const labelContent = "Favorite Animal Label";
render(
<Select
disableAnimation
isMultiline
aria-label="Favorite Animal"
data-testid="select"
label={labelContent}
labelPlacement="outside"
placeholder="placeholder"
>
<SelectItem key="penguin">Penguin</SelectItem>
<SelectItem key="zebra">Zebra</SelectItem>
<SelectItem key="shark">Shark</SelectItem>
</Select>,
);
const base = document.querySelector("[data-slot=base]");
const trigger = document.querySelector("[data-slot=trigger]");
expect(base).toHaveTextContent(labelContent);
expect(trigger).not.toHaveTextContent(labelContent);
});
it("should place the label inside when labelPlacement prop is not passed", () => {
const labelContent = "Favorite Animal Label";
render(
<Select
disableAnimation
aria-label="Favorite Animal"
data-testid="select"
label={labelContent}
placeholder="placeholder"
>
<SelectItem key="penguin">Penguin</SelectItem>
<SelectItem key="zebra">Zebra</SelectItem>
<SelectItem key="shark">Shark</SelectItem>
</Select>,
);
const trigger = document.querySelector("[data-slot=trigger]");
expect(trigger).toHaveTextContent(labelContent);
});
it("should support controlled isInvalid prop", async () => {
function Test() {
const [isInvalid, setInvalid] = React.useState(false);
return (
<>
<Select
disableAnimation
data-testid="select"
errorMessage="Invalid value"
isInvalid={isInvalid}
label="Test"
name="select"
>
<SelectItem key="one">One</SelectItem>
<SelectItem key="two">Two</SelectItem>
<SelectItem key="three">Three</SelectItem>
</Select>
<button data-testid="button" onClick={() => setInvalid((isInvalid) => !isInvalid)}>
Click Me
</button>
</>
);
}
const {getByTestId} = render(<Test />);
const select = getByTestId("select");
expect(select).not.toHaveAttribute("aria-describedby");
await user.click(getByTestId("button"));
expect(select).toHaveAttribute("aria-describedby");
expect(document.getElementById(select.getAttribute("aria-describedby")!)).toHaveTextContent(
"Invalid value",
);
});
it("should not open dropdown when hideEmptyContent is true", async () => {
const wrapper = render(
<Select
disableAnimation
hideEmptyContent
aria-label="Favorite Animal"
data-testid="hide-empty-content-true-test"
label="Favorite Animal"
>
{[]}
</Select>,
);
const select = wrapper.getByTestId("hide-empty-content-true-test");
// open the select dropdown
await user.click(select);
// assert that the select is not open
expect(select).not.toHaveAttribute("aria-expanded", "true");
// assert that the listbox is not rendered
expect(wrapper.queryByRole("listbox")).not.toBeInTheDocument();
});
it("should open dropdown when hideEmptyContent is false", async () => {
const wrapper = render(
<Select
disableAnimation
aria-label="Favorite Animal"
data-testid="hide-empty-content-false-test"
hideEmptyContent={false}
label="Favorite Animal"
>
{[]}
</Select>,
);
const select = wrapper.getByTestId("hide-empty-content-false-test");
// open the select dropdown
await user.click(select);
// assert that the select is open
expect(select).toHaveAttribute("aria-expanded", "true");
const listbox = wrapper.getByRole("listbox");
// assert that the listbox is rendered
expect(listbox).toBeInTheDocument();
// assert that the listbox items are not rendered
expect(wrapper.queryByRole("option")).not.toBeInTheDocument();
});
});
describe("Select virtualization tests", () => {
const user = userEvent.setup();
beforeAll(() => {
Object.defineProperty(HTMLElement.prototype, "scrollTo", {
configurable: true,
value: jest.fn(),
});
});
it("should work with onChange (< virtualization threshold items)", async () => {
const onChange = jest.fn();
let options = Array.from({length: 10}, (_, i) => `option ${i}`);
const wrapper = render(
<div style={{height: "200px", overflow: "auto"}}>
<Select
disableAnimation
isOpen
aria-label="Favorite Animal"
label="Favorite Animal"
onChange={onChange}
>
{options.map((o) => (
<SelectItem key={o}>{o}</SelectItem>
))}
</Select>
</div>,
);
const listbox = wrapper.getByRole("listbox");
expect(listbox).toBeTruthy();
const listboxItems = wrapper.getAllByRole("option");
expect(listboxItems.length).toBe(10);
await user.click(listboxItems[1]);
expect(onChange).toHaveBeenCalledTimes(1);
});
it("should work with onChange (at virtualization threshold items)", async () => {
const onChange = jest.fn();
let options = Array.from({length: 50}, (_, i) => `option ${i}`);
const wrapper = render(
<div style={{height: "200px", overflow: "auto"}}>
<Select
disableAnimation
isOpen
aria-label="Favorite Animal"
label="Favorite Animal"
onChange={onChange}
>
{options.map((o) => (
<SelectItem key={o}>{o}</SelectItem>
))}
</Select>
</div>,
);
const listbox = wrapper.getByRole("listbox");
expect(listbox).toBeTruthy();
const listboxItems = wrapper.getAllByRole("option");
expect(listboxItems.length).toBe(50);
await user.click(listboxItems[1]);
expect(onChange).toHaveBeenCalledTimes(1);
});
it("should work with onChange (> virtualization threshold items)", async () => {
const onChange = jest.fn();
let options = Array.from({length: 100}, (_, i) => `option ${i}`);
/* Mock dimensions */
Object.defineProperty(HTMLElement.prototype, "offsetHeight", {configurable: true, value: 200});
Object.defineProperty(HTMLElement.prototype, "scrollHeight", {configurable: true, value: 2000});
Object.defineProperty(HTMLElement.prototype, "getBoundingClientRect", {
configurable: true,
value: () => ({
top: 0,
bottom: 200,
height: 200,
left: 0,
right: 100,
width: 100,
}),
});
const wrapper = render(
<div style={{height: "200px", overflow: "auto"}}>
<Select
disableAnimation
isOpen
isVirtualized
aria-label="Favorite Animal"
itemHeight={20}
label="Favorite Animal"
maxListboxHeight={200}
onChange={onChange}
>
{options.map((o) => (
<SelectItem key={o}>{o}</SelectItem>
))}
</Select>
</div>,
);
const listbox = wrapper.getByRole("listbox");
expect(listbox).toBeTruthy();
/* Scroll to ensure visibility of the target item */
const scrollableContainer = wrapper.container.querySelector("div");
act(() => {
scrollableContainer?.scrollTo({top: 60});
});
await waitFor(() => {
const visibleItems = wrapper.getAllByRole("option");
expect(visibleItems.length).toBeGreaterThan(0);
/* Virtualized list will have listitems less than 100 */
expect(visibleItems.length).toBeLessThan(100);
});
const visibleItems = wrapper.getAllByRole("option");
await user.click(visibleItems[3]);
expect(onChange).toHaveBeenCalledTimes(1);
});
it("should work with onChange (large number of items)", async () => {
const onChange = jest.fn();
let options = Array.from({length: 300}, (_, i) => `option ${i}`);
/* Mock dimensions */
Object.defineProperty(HTMLElement.prototype, "offsetHeight", {configurable: true, value: 200});
Object.defineProperty(HTMLElement.prototype, "scrollHeight", {configurable: true, value: 6000});
const wrapper = render(
<div style={{height: "200px", overflow: "auto"}}>
<Select
disableAnimation
isOpen
isVirtualized
aria-label="Favorite Animal"
itemHeight={20}
label="Favorite Animal"
maxListboxHeight={200}
onChange={onChange}
>
{options.map((o) => (
<SelectItem key={o}>{o}</SelectItem>
))}
</Select>
</div>,
);
const listbox = wrapper.getByRole("listbox");
expect(listbox).toBeTruthy();
/* Simulate scrolling to make the target item visible */
const scrollableContainer = wrapper.container.querySelector("div");
act(() => {
scrollableContainer?.scrollTo({top: 1200});
});
await waitFor(() => {
const visibleItems = wrapper.getAllByRole("option");
expect(visibleItems.length).toBeGreaterThan(0);
/* Virtualized list will have listitems less than 300 */
expect(visibleItems.length).toBeLessThan(300);
});
const visibleItems = wrapper.getAllByRole("option");
await user.click(visibleItems[3]);
expect(onChange).toHaveBeenCalledTimes(1);
});
});
describe("Select with React Hook Form", () => {
let select1: HTMLElement;
let select2: HTMLElement;
let select3: HTMLElement;
let submitButton: HTMLButtonElement;
let wrapper: any;
let onSubmit: () => void;
beforeEach(() => {
const {result} = renderHook(() =>
useForm({
defaultValues: {
withDefaultValue: "cat",
withoutDefaultValue: "",
requiredField: "",
},
}),
);
const {
register,
formState: {errors},
handleSubmit,
} = result.current;
onSubmit = jest.fn();
wrapper = render(
<form className="flex flex-col gap-4" onSubmit={handleSubmit(onSubmit)}>
<Select
disableAnimation
data-testid="select-1"
items={itemsData}
{...register("withDefaultValue")}
aria-label="select-1"
>
{(item) => <SelectItem key={item.id}>{item.label}</SelectItem>}
</Select>
<Select
disableAnimation
data-testid="select-2"
items={itemsData}
{...register("withoutDefaultValue")}
aria-label="select-2"
>
{(item) => <SelectItem key={item.id}>{item.label}</SelectItem>}
</Select>
<Select
disableAnimation
data-testid="select-3"
items={itemsData}
{...register("requiredField", {required: true})}
aria-label="select-3"
>
{(item) => <SelectItem key={item.id}>{item.label}</SelectItem>}
</Select>
{errors.requiredField && <span className="text-danger">This field is required</span>}
<button data-testid="submit-button" type="submit">
Submit
</button>
</form>,
);
select1 = wrapper.getByTestId("select-1");
select2 = wrapper.getByTestId("select-2");
select3 = wrapper.getByTestId("select-3");
submitButton = wrapper.getByTestId("submit-button");
});
it("should work with defaultValues", () => {
expect(select1).toHaveTextContent("Cat");
expect(select2).toHaveTextContent("");
expect(select3).toHaveTextContent("");
});
it("should not submit form when required field is empty", async () => {
const user = userEvent.setup();
await user.click(submitButton);
expect(onSubmit).toHaveBeenCalledTimes(0);
});
it("should submit form when required field is not empty", async () => {
const user = userEvent.setup();
await user.click(select3);
expect(select3).toHaveAttribute("aria-expanded", "true");
let listboxItems = wrapper.getAllByRole("option");
await user.click(listboxItems[1]);
expect(select3).toHaveTextContent("Dog");
await user.click(submitButton);
expect(onSubmit).toHaveBeenCalledTimes(1);
});
});
describe("validation", () => {
let user;
beforeAll(() => {
user = userEvent.setup();
});
describe("validationBehavior=aria", () => {
it("supports validate function", async () => {
const onSubmit = jest.fn((e) => e.preventDefault());
const {getByTestId} = render(
<Form data-testid="form" validationBehavior="aria" onSubmit={onSubmit}>
<Select
aria-label="Favorite Animal"
data-testid="trigger"
defaultSelectedKeys={["penguin"]}
label="Favorite Animal"
validate={(v) => (v.includes("penguin") ? "Invalid value" : null)}
>
<SelectItem key="penguin">Penguin</SelectItem>
<SelectItem key="zebra">Zebra</SelectItem>
<SelectItem key="shark">Shark</SelectItem>
</Select>
<button data-testid="submit-button" type="submit">
Submit
</button>
</Form>,
);
const trigger = getByTestId("trigger") as HTMLButtonElement;
const select = document.querySelector("select");
const submit = getByTestId("submit-button");
// aria validation is always valid
expect(select?.validity.valid).toBe(true);
// aria validation validates on initial render
expect(trigger).toHaveAttribute("aria-describedby");
expect(select).toHaveAttribute("aria-invalid", "true");
expect(document.getElementById(trigger.getAttribute("aria-describedby")!)).toHaveTextContent(
"Invalid value",
);
await user.click(trigger);
let listboxItems = document.querySelectorAll("[role='option']");
await user.click(listboxItems[1]); // zebra
await user.click(submit);
expect(select?.validity.valid).toBe(true);
expect(trigger).not.toHaveAttribute("aria-describedby");
expect(select).not.toHaveAttribute("aria-invalid");
});
it("supports server validation", async () => {
function FormRender() {
const [serverErrors, setServerErrors] = React.useState({animal: "initial error"});
const onSubmit = (e) => {
e.preventDefault();
setServerErrors({
animal: "new error",
});
};
return (
<Form
data-testid="form"
validationBehavior="aria"
validationErrors={serverErrors}
onSubmit={onSubmit}
>
<Select
aria-label="Favorite Animal"
data-testid="trigger"
label="Favorite Animal"
name="animal"
>
<SelectItem key="penguin">Penguin</SelectItem>
<SelectItem key="zebra">Zebra</SelectItem>
<SelectItem key="shark">Shark</SelectItem>
</Select>
<button data-testid="submit-button" type="submit">
Submit
</button>
</Form>
);
}
const {getByTestId} = render(<FormRender />);
const trigger = getByTestId("trigger") as HTMLButtonElement;
const select = document.querySelector("select");
const submit = getByTestId("submit-button");
// aria validation is always valid
expect(select?.validity.valid).toBe(true);
expect(trigger).toHaveAttribute("aria-describedby");
expect(select).toHaveAttribute("aria-invalid", "true");
expect(document.getElementById(trigger.getAttribute("aria-describedby")!)).toHaveTextContent(
"initial error",
);
await user.click(trigger);
let listboxItems = document.querySelectorAll("[role='option']");
await user.click(listboxItems[1]); // zebra
expect(select?.validity.valid).toBe(true);
expect(trigger).not.toHaveAttribute("aria-describedby");
expect(select).not.toHaveAttribute("aria-invalid");
await user.click(submit);
expect(select?.validity.valid).toBe(true);
expect(trigger).toHaveAttribute("aria-describedby");
expect(select).toHaveAttribute("aria-invalid");
expect(document.getElementById(trigger.getAttribute("aria-describedby")!)).toHaveTextContent(
"new error",
);
});
});
describe("validationBehavior=native", () => {
it("supports isRequired", async () => {
function FormRender() {
const onSubmit = jest.fn((e) => e.preventDefault());
return (
<Form data-testid="form" validationBehavior="native" onSubmit={onSubmit}>
<Select
disableAnimation
isRequired
aria-label="Favorite Animal"
data-testid="trigger"
label="Favorite Animal"
name="animal"
>
<SelectItem key="cat">Cat</SelectItem>
<SelectItem key="dog">Dog</SelectItem>
<SelectItem key="penguin">Penguin</SelectItem>
<SelectItem key="zebra">Zebra</SelectItem>
<SelectItem key="shark">Shark</SelectItem>
</Select>
<button data-testid="submit-button" type="submit">
Submit
</button>
</Form>
);
}
const {getByTestId} = render(<FormRender />);
const trigger = getByTestId("trigger") as HTMLButtonElement;
const select = document.querySelector("select");
const submit = getByTestId("submit-button");
expect(select?.validity.valid).toBe(false);
expect(select?.validity.valueMissing).toBe(true);
// native validation does not validate until submit
expect(select).toHaveAttribute("required");
expect(trigger).not.toHaveAttribute("aria-describedby");
await user.click(submit);
expect(select?.validity.valid).toBe(false);
expect(select?.validity.valueMissing).toBe(true);
expect(trigger).toHaveAttribute("aria-describedby");
await user.click(trigger);
let listboxItems = document.querySelectorAll("[role='option']");
await user.click(listboxItems[0]);
await user.click(submit);
expect(select?.validity.valid).toBe(true);
expect(trigger).not.toHaveAttribute("aria-describedby");
});
it("supports validate function", async () => {
const onSubmit = jest.fn((e) => e.preventDefault());
const {getByTestId} = render(
<Form data-testid="form" validationBehavior="native" onSubmit={onSubmit}>
<Select
disableAnimation
aria-label="Favorite Animal"
data-testid="trigger"
defaultSelectedKeys={["penguin"]}
label="Favorite Animal"
validate={(v) => (v.includes("penguin") ? "Invalid value" : null)}
>
<SelectItem key="penguin">Penguin</SelectItem>
<SelectItem key="zebra">Zebra</SelectItem>
<SelectItem key="shark">Shark</SelectItem>
</Select>
<button data-testid="submit-button" type="submit">
Submit
</button>
</Form>,
);
const trigger = getByTestId("trigger") as HTMLButtonElement;
const select = document.querySelector("select");
const submit = getByTestId("submit-button");
expect(select?.validity.valid).toBe(false);
expect(select?.validity.customError).toBe(true);
// native validation does not validate until submit
expect(trigger).not.toHaveAttribute("aria-describedby");
expect(select).not.toHaveAttribute("aria-invalid", "true");
await user.click(submit);
expect(select?.validity.valid).toBe(false);
expect(select?.validity.customError).toBe(true);
expect(trigger).toHaveAttribute("aria-describedby");
expect(select).toHaveAttribute("aria-invalid", "true");
expect(document.getElementById(trigger.getAttribute("aria-describedby")!)).toHaveTextContent(
"Invalid value",
);
await user.click(trigger);
let listboxItems = document.querySelectorAll("[role='option']");
await user.click(listboxItems[1]); // zebra
await user.click(submit);
expect(select?.validity.valid).toBe(true);
expect(trigger).not.toHaveAttribute("aria-describedby");
expect(select).not.toHaveAttribute("aria-invalid");
});
it("supports server validation", async () => {
function FormRender() {
const [serverErrors, setServerErrors] = React.useState({animal: "initial error"});
const onSubmit = (e) => {
e.preventDefault();
setServerErrors({
animal: "new error",
});
};
return (
<Form
data-testid="form"
validationBehavior="native"
validationErrors={serverErrors}
onSubmit={onSubmit}
>
<Select
aria-label="Favorite Animal"
data-testid="trigger"
label="Favorite Animal"
name="animal"
>
<SelectItem key="penguin">Penguin</SelectItem>
<SelectItem key="zebra">Zebra</SelectItem>
<SelectItem key="shark">Shark</SelectItem>
</Select>
<button data-testid="submit-button" type="submit">
Submit
</button>
</Form>
);
}
const {getByTestId} = render(<FormRender />);
const trigger = getByTestId("trigger") as HTMLButtonElement;
const select = document.querySelector("select");
const submit = getByTestId("submit-button");
expect(select?.validity.valid).toBe(false);
expect(select?.validity.customError).toBe(true);
expect(trigger).toHaveAttribute("aria-describedby");
expect(select).toHaveAttribute("aria-invalid", "true");
expect(document.getElementById(trigger.getAttribute("aria-describedby")!)).toHaveTextContent(
"initial error",
);
await user.click(trigger);
let listboxItems = document.querySelectorAll("[role='option']");
await user.click(listboxItems[1]); // zebra
expect(select?.validity.valid).toBe(true);
expect(trigger).not.toHaveAttribute("aria-describedby");
expect(select).not.toHaveAttribute("aria-invalid");
await user.click(submit);
expect(select?.validity.valid).toBe(false);
expect(select?.validity.customError).toBe(true);
expect(trigger).toHaveAttribute("aria-describedby");
expect(select).toHaveAttribute("aria-invalid");
expect(document.getElementById(trigger.getAttribute("aria-describedby")!)).toHaveTextContent(
"new error",
);
});
});
});