@nnc-digital/nnc-design-system/build/library/components/BinCollection/BinCollection.types.d.ts

Design system for West & North Northamptonshire Councils, two unitary councils encompassing Wellingborough, Corby, Daventry, East Northants, Kettering, Northampton, Northamptonshire County and South Northants.

import { AddressProps, SovereignProps, UnitaryProps } from '../../helpers/api-helpers';
export interface BinCollectionProps {
    /**
     * Title of bin collection search
     */
    title?: string;
    /**
     * Error in the form
     */
    formError?: boolean;
    /**
     * Link to send the user to another related service page or resource.
     */
    relatedServiceLink?: string;
    /**
     * Modifies search behavior based on the specific area (e.g., different collection zones or services)
     */
    isSpecificArea?: boolean;
    /**
     * graphqlApiEndpoint of the Drupal application API
     */
    graphqlApiEndpoint?: string;
    isLoading?: boolean;
    errorText?: string;
    addressOptions?: AddressOption[];
    calendarEvents?: Record<string, Date[]>;
    onAddressChange?: (e: React.ChangeEvent<HTMLSelectElement>) => void;
    onFormSubmit?: (e: React.FormEvent<HTMLFormElement>) => void;
    resetForm?: () => void;
}
export interface AddressOption {
    /**
     * The title of the address
     */
    title: string;
    /**
     * The uprn value
     */
    value: string;
    /**
     * The address as a one line string
     */
    info?: string;
}
export interface AddressOptionInfoProps {
    /**
     * An array of sovereigns
     */
    sovereigns: SovereignProps[];
    /**
     * An array of Unitaries
     */
    unitaries: UnitaryProps[];
    /**
     * An array of addresses for the postcode
     */
    addresses: AddressProps[];
}
export interface CalendarEvent {
    /**
     * The type of the event
     */
    type: string;
    /**
     * The date value
     */
    date: string;
}