An open source design system that's fully customizable and agent ready
TypeScript
docs(useInputContainer): add a search field wrapper example block (#9619)
Parman Mohammadalizadeh7b87e121fe8c
diff --git a/.changeset/use-input-container-search-field-example.md b/.changeset/use-input-container-search-field-example.mdnew file mode 100644index 0000000000..7ddcdf7875--- /dev/null+++ b/.changeset/use-input-container-search-field-example.md@@ -0,0 +1,7 @@+---+'@astryxdesign/cli': patch+---++[docs] A new `useInputContainer — Search Field Wrapper` example block builds a custom search field with a leading search icon, padding and a trailing Clear button. `useInputContainer` puts focus in the input when the icon or the padding is clicked, and a click on Clear stays with Clear. Copy it with `astryx template useInputContainerHookUsage <path>`.++@MannXodiff --git a/apps/sandbox/scripts/next-export-routes.json b/apps/sandbox/scripts/next-export-routes.jsonindex 56c128827e..be2d3f03f7 100644--- a/apps/sandbox/scripts/next-export-routes.json+++ b/apps/sandbox/scripts/next-export-routes.json@@ -800,6 +800,7 @@"/templates/useHotkeysHookUsage/","/templates/useIconHookUsage/","/templates/useImageModeHookUsage/",+ "/templates/useInputContainerHookUsage/","/templates/useInputStatusIconHookUsage/","/templates/useKeyboardHintHookUsage/","/templates/useLinkComponentHookUsage/",diff --git a/internal/shadcn-registry/routes.lock.json b/internal/shadcn-registry/routes.lock.jsonindex a64f540b41..11ec452452 100644--- a/internal/shadcn-registry/routes.lock.json+++ b/internal/shadcn-registry/routes.lock.json@@ -3731,6 +3731,11 @@"path": "examples/use-image-mode/photo-caption","aliases": []},+ {+ "name": "example-use-input-container-search-field-wrapper",+ "path": "examples/use-input-container/search-field-wrapper",+ "aliases": []+ },{"name": "example-use-input-status-icon-coupon-code-status","path": "examples/use-input-status-icon/coupon-code-status",diff --git a/packages/cli/api/template/use-input-container-hook-usage.test.tsx b/packages/cli/api/template/use-input-container-hook-usage.test.tsxnew file mode 100644index 0000000000..a3a65735d4--- /dev/null+++ b/packages/cli/api/template/use-input-container-hook-usage.test.tsx@@ -0,0 +1,104 @@+// Copyright (c) Meta Platforms, Inc. and affiliates.+// @vitest-environment jsdom++/**+ * The useInputContainer example puts focus in its search input when the+ * search icon or the field's padding is clicked, while the Clear button keeps+ * its own click.+ */++import {act} from 'react';+import {createRoot, type Root} from 'react-dom/client';+import {afterEach, beforeEach, describe, expect, it, vi} from 'vitest';+import UseInputContainerHookUsage from '../../assets/templates/blocks/components/Hooks/useInputContainerHookUsage';++// The node project does not compile StyleX, and the field's styles are not+// under test.+vi.mock('@stylexjs/stylex', () => ({+ create: <T,>(styles: T) => styles,+ props: () => ({}),+}));++(globalThis as {IS_REACT_ACT_ENVIRONMENT?: boolean}).IS_REACT_ACT_ENVIRONMENT =+ true;++let root: Root | null = null;+let container: HTMLElement;++function input(): HTMLInputElement {+ const element = container.querySelector('input');+ if (element == null) {+ throw new Error('no search input rendered');+ }+ return element;+}++function field(): HTMLElement {+ const element = input().parentElement;+ if (element == null) {+ throw new Error('the search input has no field');+ }+ return element;+}++function click(target: Element): void {+ act(() => {+ target.dispatchEvent(+ new MouseEvent('click', {bubbles: true, cancelable: true}),+ );+ });+}++function type(value: string): void {+ const setValue = Object.getOwnPropertyDescriptor(+ HTMLInputElement.prototype,+ 'value',+ )?.set;+ act(() => {+ setValue?.call(input(), value);+ input().dispatchEvent(new Event('input', {bubbles: true}));+ });+}++beforeEach(() => {+ container = document.createElement('div');+ document.body.appendChild(container);+ act(() => {+ root = createRoot(container);+ root.render(<UseInputContainerHookUsage />);+ });+});++afterEach(() => {+ act(() => root?.unmount());+ root = null;+ container.remove();+ vi.restoreAllMocks();+});++describe('useInputContainer example', () => {+ it('focuses the input when the search icon is clicked', () => {+ const icon = field().querySelector('svg');+ expect(icon).not.toBeNull();+ click(icon as SVGElement);+ expect(document.activeElement).toBe(input());+ });++ it("focuses the input when the field's padding is clicked", () => {+ click(field());+ expect(document.activeElement).toBe(input());+ });++ it('lets the Clear button handle its own click', () => {+ type('running shoes');+ const clear = container.querySelector('button');+ expect(clear).not.toBeNull();+ const focus = vi.spyOn(input(), 'focus');++ click(clear as HTMLButtonElement);++ expect(input().value).toBe('');+ expect(container.querySelector('button')).toBeNull();+ expect(focus).toHaveBeenCalledTimes(1);+ });+});diff --git a/packages/cli/assets/templates/blocks/components/Hooks/useInputContainerHookUsage.doc.mjs b/packages/cli/assets/templates/blocks/components/Hooks/useInputContainerHookUsage.doc.mjsnew file mode 100644index 0000000000..15100e2783--- /dev/null+++ b/packages/cli/assets/templates/blocks/components/Hooks/useInputContainerHookUsage.doc.mjs@@ -0,0 +1,15 @@+// Copyright (c) Meta Platforms, Inc. and affiliates.++/** @type {import('@astryxdesign/cli/authoring').TemplateDoc} */+export const doc = {+ type: 'block',+ exampleFor: 'useInputContainer',+ name: 'useInputContainer — Search Field Wrapper',+ displayName: 'useInputContainer — Search Field Wrapper',+ description:+ 'A custom search field wrapper with a leading search icon, padding and a trailing Clear button. useInputContainer puts focus in the input when the icon or the padding is clicked, while a click on Clear empties the field without the wrapper taking it over.',+ isReady: true,+ aspectRatio: 4 / 3,+ componentsUsed: ['Icon', 'InputClearButton'],+ icons: {MagnifyingGlassIcon: 'search'},+};diff --git a/packages/cli/assets/templates/blocks/components/Hooks/useInputContainerHookUsage.tsx b/packages/cli/assets/templates/blocks/components/Hooks/useInputContainerHookUsage.tsxnew file mode 100644index 0000000000..e1bbd48981--- /dev/null+++ b/packages/cli/assets/templates/blocks/components/Hooks/useInputContainerHookUsage.tsx@@ -0,0 +1,93 @@+// Copyright (c) Meta Platforms, Inc. and affiliates.++'use client';++import {useRef, useState} from 'react';+import * as stylex from '@stylexjs/stylex';+import {InputClearButton} from '@astryxdesign/core/Field';+import {useInputContainer} from '@astryxdesign/core/hooks';+import {Icon} from '@astryxdesign/core/Icon';+import {+ colorVars,+ focusVars,+ radiusVars,+ spacingVars,+} from '@astryxdesign/core/theme/tokens.stylex';+import {MagnifyingGlassIcon} from '@heroicons/react/24/outline';++const styles = stylex.create({+ field: {+ display: 'flex',+ alignItems: 'center',+ gap: spacingVars['--spacing-2'],+ width: 320,+ minHeight: 40,+ paddingInline: spacingVars['--spacing-3'],+ borderWidth: 1,+ borderStyle: 'solid',+ borderColor: colorVars['--color-border-emphasized'],+ borderRadius: radiusVars['--radius-element'],+ cursor: 'text',+ outlineWidth: {+ default: 0,+ ':has(> input:focus-visible)': focusVars['--focus-outline-width'],+ },+ outlineStyle: {+ default: 'none',+ ':has(> input:focus-visible)': focusVars['--focus-outline-style'],+ },+ outlineColor: {+ default: null,+ ':has(> input:focus-visible)': focusVars['--focus-outline-color'],+ },+ outlineOffset: {+ default: 0,+ ':has(> input:focus-visible)': focusVars['--focus-outline-offset'],+ },+ },+ input: {+ flexGrow: 1,+ minWidth: 0,+ borderStyle: 'none',+ outlineStyle: 'none',+ backgroundColor: 'transparent',+ color: 'inherit',+ fontFamily: 'inherit',+ fontSize: 'inherit',+ },+});++export default function UseInputContainerHookUsage() {+ const containerRef = useRef<HTMLDivElement>(null);+ const inputRef = useRef<HTMLInputElement>(null);+ const [query, setQuery] = useState('');+ const {onClick, onMouseUp} = useInputContainer({containerRef, inputRef});++ return (+ <div+ ref={containerRef}+ onClick={onClick}+ onMouseUp={onMouseUp}+ {...stylex.props(styles.field)}>+ <Icon icon={MagnifyingGlassIcon} color="secondary" />+ <input+ ref={inputRef}+ type="text"+ aria-label="Search"+ placeholder="Search"+ value={query}+ onChange={event => setQuery(event.target.value)}+ {...stylex.props(styles.input)}+ />+ {query !== '' && (+ <InputClearButton+ label="Clear search"+ onClick={() => {+ setQuery('');+ inputRef.current?.focus();+ }}+ />+ )}+ </div>+ );+}diff --git a/packages/cli/test/__golden__/no-icon-set/search-icon-set.json b/packages/cli/test/__golden__/no-icon-set/search-icon-set.jsonindex 192899d178..03ca4df764 100644--- a/packages/cli/test/__golden__/no-icon-set/search-icon-set.json+++ b/packages/cli/test/__golden__/no-icon-set/search-icon-set.json@@ -3,7 +3,7 @@"type": "search","data": {"query": "icon set",- "matchCount": 384,+ "matchCount": 385,"results": [{"domain": "doc",diff --git a/packages/cli/test/__golden__/no-icon-set/search-icon-set.txt b/packages/cli/test/__golden__/no-icon-set/search-icon-set.txtindex 8c9e898e31..a9c6d55d79 100644--- a/packages/cli/test/__golden__/no-icon-set/search-icon-set.txt+++ b/packages/cli/test/__golden__/no-icon-set/search-icon-set.txt@@ -1,4 +1,4 @@-Results for "icon set" (20 of 384)+Results for "icon set" (20 of 385)name: authoring/building-blocks/templates/build-the-template/template-assets/template-iconssection: use-astryx-icondomain: docdiff --git a/packages/cli/test/__golden__/no-icon-set/search-icon.json b/packages/cli/test/__golden__/no-icon-set/search-icon.jsonindex 5cd94a5cb7..436b14bcc7 100644--- a/packages/cli/test/__golden__/no-icon-set/search-icon.json+++ b/packages/cli/test/__golden__/no-icon-set/search-icon.json@@ -3,7 +3,7 @@"type": "search","data": {"query": "icon",- "matchCount": 230,+ "matchCount": 231,"results": [{"domain": "component",diff --git a/packages/cli/test/__golden__/no-icon-set/search-icon.txt b/packages/cli/test/__golden__/no-icon-set/search-icon.txtindex a7c3af3cc3..4b88e33b26 100644--- a/packages/cli/test/__golden__/no-icon-set/search-icon.txt+++ b/packages/cli/test/__golden__/no-icon-set/search-icon.txt@@ -1,4 +1,4 @@-Results for "icon" (20 of 230)+Results for "icon" (20 of 231)name: Icondomain: componentpackage: @astryxdesign/corediff --git a/packages/cli/test/__golden__/no-icon-set/search-search.json b/packages/cli/test/__golden__/no-icon-set/search-search.jsonindex f5663523c8..369ef7e8a9 100644--- a/packages/cli/test/__golden__/no-icon-set/search-search.json+++ b/packages/cli/test/__golden__/no-icon-set/search-search.json@@ -3,7 +3,7 @@"type": "search","data": {"query": "search",- "matchCount": 115,+ "matchCount": 116,"results": [{"domain": "doc",diff --git a/packages/cli/test/__golden__/no-icon-set/search-search.txt b/packages/cli/test/__golden__/no-icon-set/search-search.txtindex bde7338d7d..d20ff3338f 100644--- a/packages/cli/test/__golden__/no-icon-set/search-search.txt+++ b/packages/cli/test/__golden__/no-icon-set/search-search.txt@@ -1,4 +1,4 @@-Results for "search" (20 of 115)+Results for "search" (20 of 116)name: cli/api/functions/searchdomain: docpackage: @astryxdesign/cli