@canonical/maas-react-components 1.30.0 → 1.31.0

package/dist/src/lib/components/QueryInput/QueryInput.d.ts

@@ -0,0 +1,50 @@
+import { ReactElement, DetailedHTMLProps, HTMLAttributes, Dispatch, SetStateAction } from 'react';
+export type Suggestion = {
+    value: string;
+    type: string;
+    disabled?: boolean;
+};
+type QueryInputProps = {
+    className?: string;
+    disabled?: boolean;
+    search: string;
+    setSearch: Dispatch<SetStateAction<string>>;
+    context: string;
+    setContext: Dispatch<SetStateAction<string>>;
+    setToken: Dispatch<SetStateAction<string>>;
+    suggestions: Suggestion[];
+    isLoading?: boolean;
+    placeholder?: string;
+} & DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>;
+/**
+ * QueryInput - A feature-rich search query constructor for React applications
+ *
+ * A keyboard-centric search query constructor field with externally controlled
+ * assistive suggestion and insertion features
+ *
+ * @param {Object} props - Component props
+ * @param {string} [props.className] - Additional CSS class for the table wrapper
+ * @param {disabled} [props.disabled] - Field disabling boolean
+ * @param {search} [props.search] - Externally controlled search query string
+ * @param {setSearch} [props.setSearch] - Search query string setter
+ * @param {context} [props.context] - Externally controlled suggestion context
+ * @param {setContext} [props.setContext] - Suggestion context setter
+ * @param {setToken} [props.setToken] - Partial token string for autocomplete
+ * @param {suggestions} [props.suggestions] - Context-aware suggestions
+ * @param {isLoading} [props.isLoading] - Loading suggestion state boolean
+ * @param {placeholder} [props.placeholder] - Search field placeholder text
+ *
+ * @returns {ReactElement} - The rendered query input component
+ *
+ * @example
+ * <QueryInput
+ *   search={search}
+ *   setSearch={setSearch}
+ *   context={context}
+ *   setContext={setContext}
+ *   setToken={setToken}
+ *   suggestions={suggestions}
+ * />
+ */
+export declare const QueryInput: ({ className, disabled, search, setSearch, context, setContext, setToken, suggestions, isLoading, placeholder, ...props }: QueryInputProps) => ReactElement;
+export {};

package/dist/src/lib/components/QueryInput/QueryInput.stories.d.ts

@@ -0,0 +1,8 @@
+import { Meta, StoryObj } from '@storybook/react';
+import { QueryInput } from '../..';
+declare const meta: Meta<typeof QueryInput>;
+export default meta;
+type Story = StoryObj<typeof QueryInput>;
+export declare const Default: Story;
+export declare const Disabled: Story;
+export declare const Loading: Story;

package/dist/src/lib/components/QueryInput/QueryInput.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/lib/components/QueryInput/index.d.ts

@@ -0,0 +1 @@
+export * from './QueryInput';

package/dist/src/lib/components/index.d.ts

@@ -6,3 +6,4 @@ export * from './MultiSelect';
 export * from './DynamicTable';
 export * from './TableCaption';
 export * from './GenericTable';
+export * from './QueryInput';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@canonical/maas-react-components",
   "description": "React components for use in MAAS UI projects.",
-  "version": "1.30.0",
+  "version": "1.31.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/canonical/maas-react-components.git"