@australiangreens/ag-internal-components 0.0.57 → 0.0.59

package/dist/components/FetchAutocomplete/FetchAutocomplete.d.ts

@@ -0,0 +1,46 @@
+import { SyntheticEvent } from 'react';
+import { AutocompleteGenericEntity, FetchAutocompleteChangeReason } from './types';
+export interface FetchAutocompleteProps<EntityType extends AutocompleteGenericEntity> {
+    /**
+     * Callback fired when the value changes. This is passed directly to the
+     * underlying Autocomplete, but it is triggered by the Autocomplete's own
+     * onChange, with the exception of the deletion of chips.
+     */
+    onChange: (newValue: EntityType[], reason: FetchAutocompleteChangeReason, event: SyntheticEvent<Element, Event>) => unknown;
+    /** The sequence of entity types returned. */
+    value: EntityType[];
+    /**
+     * A minimum length of characters in the Autocomplete before the lookup is called. If not set,
+     * then the lookup is called every time.
+     */
+    minLength?: number;
+    /** A nice label for the autocomplete. */
+    label: string;
+    /** The lookup function, for looking up EntityType options from a remote resource. */
+    lookup?: (lookupValue: string, abortSignal: AbortSignal) => Promise<EntityType[] | undefined | null | void>;
+    /** If you have your EntityType options at hand, preload them instead, and save the
+     * user's time. They should all be available when the user clicks on the drop down
+     * menu, without even a single keystroke provided. This is the property you want.
+     */
+    preLoadedOptions?: EntityType[] | undefined;
+    /** The popup icon */
+    popupIcon?: React.ReactNode;
+    /**
+     * When testing, it is useful to give data-testid attributes to parts inside
+     * the component. This prefix is useful to distinguish one FetchAutocomplete
+     * instance from others.
+     */
+    dataTestidPrefix?: string;
+    loadingText?: string;
+    noOptionsText?: string;
+    error?: boolean;
+    helperText?: React.ReactNode;
+    enableHighlighting?: boolean;
+}
+/**
+ * A wrapper around MUI's Autocomplete component, specifically for use with live
+ * as-you-type fetching from an api and styled the way we want it across the app
+ * by default.
+ */
+export default function FetchAutocomplete<EntityType extends AutocompleteGenericEntity>({ lookup, enableHighlighting, onChange, minLength, label, value, dataTestidPrefix, loadingText, noOptionsText, popupIcon, error, helperText, preLoadedOptions, }: FetchAutocompleteProps<EntityType>): JSX.Element;
+//# sourceMappingURL=FetchAutocomplete.d.ts.map

package/dist/components/FetchAutocomplete/FetchAutocomplete.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FetchAutocomplete.d.ts","sourceRoot":"","sources":["../../../src/components/FetchAutocomplete/FetchAutocomplete.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAgC,cAAc,EAAE,MAAM,OAAO,CAAC;AAerE,OAAO,EACL,yBAAyB,EAEzB,6BAA6B,EAC9B,MAAM,SAAS,CAAC;AAEjB,MAAM,WAAW,sBAAsB,CAAC,UAAU,SAAS,yBAAyB;IAClF;;;;OAIG;IACH,QAAQ,EAAE,CACR,QAAQ,EAAE,UAAU,EAAE,EACtB,MAAM,EAAE,6BAA6B,EACrC,KAAK,EAAE,cAAc,CAAC,OAAO,EAAE,KAAK,CAAC,KAClC,OAAO,CAAC;IAEb,6CAA6C;IAC7C,KAAK,EAAE,UAAU,EAAE,CAAC;IAEpB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,yCAAyC;IACzC,KAAK,EAAE,MAAM,CAAC;IAEd,qFAAqF;IACrF,MAAM,CAAC,EAAE,CACP,WAAW,EAAE,MAAM,EACnB,WAAW,EAAE,WAAW,KACrB,OAAO,CAAC,UAAU,EAAE,GAAG,SAAS,GAAG,IAAI,GAAG,IAAI,CAAC,CAAC;IAErD;;;OAGG;IACH,gBAAgB,CAAC,EAAE,UAAU,EAAE,GAAG,SAAS,CAAC;IAE5C,qBAAqB;IACrB,SAAS,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAE5B;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,UAAU,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC7B,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED;;;;GAIG;AACH,MAAM,CAAC,OAAO,UAAU,iBAAiB,CAAC,UAAU,SAAS,yBAAyB,EAAE,EACtF,MAAuB,EACvB,kBAAyB,EACzB,QAAQ,EACR,SAAS,EACT,KAAK,EACL,KAAK,EACL,gBAAgB,EAChB,WAA0B,EAC1B,aAA4B,EAC5B,SAAgC,EAChC,KAAa,EACb,UAAe,EACf,gBAA4B,GAC7B,EAAE,sBAAsB,CAAC,UAAU,CAAC,eA8NpC"}

package/dist/components/FetchAutocomplete/FetchAutocomplete.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=FetchAutocomplete.test.d.ts.map

package/dist/components/FetchAutocomplete/FetchAutocomplete.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FetchAutocomplete.test.d.ts","sourceRoot":"","sources":["../../../src/components/FetchAutocomplete/FetchAutocomplete.test.tsx"],"names":[],"mappings":""}

package/dist/components/FetchAutocomplete/index.d.ts

@@ -0,0 +1,4 @@
+export { default } from './FetchAutocomplete';
+export * from './FetchAutocomplete';
+export * from './types';
+//# sourceMappingURL=index.d.ts.map

package/dist/components/FetchAutocomplete/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/FetchAutocomplete/index.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,cAAc,qBAAqB,CAAC;AACpC,cAAc,SAAS,CAAC"}

package/dist/components/FetchAutocomplete/types.d.ts

@@ -0,0 +1,15 @@
+export type AutocompleteGenericEntityIdType = number | string;
+/** These are an extension of the reasons for MUI's Autocomplete. We add delete
+ * reason. */
+export type FetchAutocompleteChangeReason = 'createOption' | 'selectOption' | 'removeOption' | 'blur' | 'clear' | 'delete';
+export interface AutocompleteGenericEntity {
+    id: AutocompleteGenericEntityIdType;
+    label: string;
+    /**
+     * optional chip label specifically for displaying custom chip
+     * eg. search by event name: show truncated label and append startDate
+     */
+    chipLabel?: string;
+    tooltipContent?: string;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/components/FetchAutocomplete/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/components/FetchAutocomplete/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,+BAA+B,GAAG,MAAM,GAAG,MAAM,CAAC;AAE9D;aACa;AACb,MAAM,MAAM,6BAA6B,GACrC,cAAc,GACd,cAAc,GACd,cAAc,GACd,MAAM,GACN,OAAO,GACP,QAAQ,CAAC;AAEb,MAAM,WAAW,yBAAyB;IACxC,EAAE,EAAE,+BAA+B,CAAC;IACpC,KAAK,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB"}

package/dist/components/index.d.ts

@@ -4,4 +4,6 @@ export { default as NavBar } from './NavBar';
 export * from './NavBar';
 export { default as AgDialog } from './AgDialog';
 export * from './AgDialog';
+export { default as FetchAutocomplete } from './FetchAutocomplete';
+export * from './FetchAutocomplete';
 //# sourceMappingURL=index.d.ts.map

package/dist/components/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/components/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACjE,cAAc,oBAAoB,CAAC;AAEnC,OAAO,EAAE,OAAO,IAAI,MAAM,EAAE,MAAM,UAAU,CAAC;AAC7C,cAAc,UAAU,CAAC;AAEzB,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,YAAY,CAAC;AACjD,cAAc,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/components/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACjE,cAAc,oBAAoB,CAAC;AAEnC,OAAO,EAAE,OAAO,IAAI,MAAM,EAAE,MAAM,UAAU,CAAC;AAC7C,cAAc,UAAU,CAAC;AAEzB,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,YAAY,CAAC;AACjD,cAAc,YAAY,CAAC;AAE3B,OAAO,EAAE,OAAO,IAAI,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACnE,cAAc,qBAAqB,CAAC"}