@giddaa-housing/ui 1.0.0 → 1.2.0

package/dist/filter.d.ts

@@ -0,0 +1,118 @@
+import * as React from "react";
+//#region src/filter.d.ts
+type FilterJoin = "AND" | "OR";
+type FilterFieldType = "text" | "number" | "date" | "select" | "multiSelect" | "range" | "boolean";
+type FilterCondition = "equals" | "greaterThan" | "lessThan" | "contains";
+type FilterRangeValue = {
+  min?: number;
+  max?: number;
+};
+type FilterValue = string | number | boolean | Array<string | number> | FilterRangeValue;
+type SerializedFilter = {
+  connector: FilterJoin;
+  field: string;
+  action: FilterCondition;
+  value: string | number | boolean | Array<string | number>;
+};
+type FilterFieldOption = {
+  label: string;
+  value: string | number;
+};
+type FilterFieldValueProps = {
+  field: FilterFieldConfig;
+  value?: FilterValue;
+  onChange: (value?: FilterValue) => void;
+  invalid: boolean;
+  error?: string;
+};
+type FilterFieldConfig = {
+  /** The field id sent to the api e.g Name, for nested fields use dot notation e.g Address.City */
+  field: string;
+  label: string;
+  type: FilterFieldType;
+  /** Static options for select or multiSelect fields, also shown while `loadOptions` is in flight. */
+  options?: FilterFieldOption[];
+  /**
+   * Lazily load select options. Only called once the dropdown is opened and
+   * the result is cached per field, so wire it to `fetch`, a server action,
+   * or `queryClient.fetchQuery` — no data library is assumed.
+   */
+  loadOptions?: () => Promise<FilterFieldOption[]>;
+  /**
+   * Replace the built-in value input for this field. Compose the exported
+   * `FilterValue*` components to keep styling consistent, e.g. wire
+   * `FilterValueSelect` to React Query in your app.
+   */
+  renderValue?: (props: FilterFieldValueProps) => React.ReactNode;
+};
+type FilterProps = {
+  children: React.ReactNode;
+  /** Connector used between generated filters. */
+  defaultJoin?: FilterJoin;
+  fields: FilterFieldConfig[];
+  /** Receives the serialized filter JSON string plus the structured filters. */
+  onApply: (serialized: string, filters: SerializedFilter[]) => void;
+  /** Serialized filters used to initialize state, e.g. read from the URL. */
+  defaultValue?: string;
+};
+declare function Filter({ children, defaultJoin, fields, onApply, defaultValue }: FilterProps): React.JSX.Element;
+type FilterTriggerProps = {
+  children?: React.ReactNode;
+  className?: string;
+  countClassName?: string;
+  /** Hide the count badge while no filters are applied. */
+  hideCountWhenZero?: boolean;
+  render?: (props: {
+    count: number;
+  }) => React.ReactNode;
+};
+declare function FilterTrigger({ children, className, countClassName, hideCountWhenZero, render }: FilterTriggerProps): React.JSX.Element;
+type FilterContentProps = {
+  addFilterLabel?: React.ReactNode;
+  className?: string;
+  label?: React.ReactNode;
+};
+declare function FilterContent({ addFilterLabel, className, label }: FilterContentProps): React.JSX.Element;
+type FilterValueInputProps = {
+  value?: FilterValue;
+  onChange: (value?: FilterValue) => void;
+  invalid?: boolean;
+  placeholder?: string;
+};
+declare function FilterValueText({ value, onChange, invalid, placeholder }: FilterValueInputProps): React.JSX.Element;
+declare function FilterValueNumber({ value, onChange, invalid, placeholder }: FilterValueInputProps): React.JSX.Element;
+declare function FilterValueDate({ value, onChange, invalid }: FilterValueInputProps): React.JSX.Element;
+type FilterValueBooleanProps = FilterValueInputProps & {
+  trueLabel?: string;
+  falseLabel?: string;
+};
+declare function FilterValueBoolean({ value, onChange, invalid, placeholder, trueLabel, falseLabel }: FilterValueBooleanProps): React.JSX.Element;
+declare function FilterValueRange({ value, onChange, invalid }: FilterValueInputProps): React.JSX.Element;
+type FilterValueSelectProps = FilterValueInputProps & {
+  options: FilterFieldOption[];
+  multiple?: boolean;
+  loading?: boolean;
+  emptyMessage?: React.ReactNode;
+  open?: boolean;
+  onOpenChange?: (open: boolean) => void;
+};
+declare function FilterValueSelect({ value, onChange, invalid, placeholder, options, multiple, loading, emptyMessage, open, onOpenChange }: FilterValueSelectProps): React.JSX.Element;
+type FilterApplyButtonProps = {
+  children?: React.ReactNode;
+  className?: string;
+  onApplySuccess?: () => void;
+};
+declare function FilterApplyButton({ children, className, onApplySuccess }: FilterApplyButtonProps): React.JSX.Element;
+type FilterResetButtonProps = {
+  children?: React.ReactNode;
+  className?: string;
+  onReset?: () => void;
+};
+declare function FilterResetButton({ children, className, onReset }: FilterResetButtonProps): React.JSX.Element;
+/**
+ * Parse a serialized filter string (as produced by `onApply`) back into
+ * structured filters. Invalid or malformed entries are dropped.
+ */
+declare function parseSerializedFilters(value: string): SerializedFilter[];
+//#endregion
+export { Filter, FilterApplyButton, type FilterApplyButtonProps, type FilterCondition, FilterContent, type FilterContentProps, type FilterFieldConfig, type FilterFieldOption, type FilterFieldType, type FilterFieldValueProps, type FilterJoin, type FilterProps, type FilterRangeValue, FilterResetButton, type FilterResetButtonProps, FilterTrigger, type FilterTriggerProps, type FilterValue, FilterValueBoolean, type FilterValueBooleanProps, FilterValueDate, type FilterValueInputProps, FilterValueNumber, FilterValueRange, FilterValueSelect, type FilterValueSelectProps, FilterValueText, type SerializedFilter, parseSerializedFilters };