bastilian-tabletools
    Preparing search index...

    Function useBulkSelect

    • Provides properties for a Pattternfly (based) Table and Toolbar component to implement bulk selection

      Parameters

      • Optionaloptions: {
            identifier?: string;
            itemIdsInTable?: Function;
            itemIdsOnPage?: any[];
            onSelect?: Function;
            preselected?: any[];
            selected?: any[];
            total?: number;
        }

        AsyncTableTools options

        • Optionalidentifier?: string

          Property of the items that should be used as ID to select them

        • OptionalitemIdsInTable?: Function

          Function to call to retrieve IDs when "Select All" is chosen

        • OptionalitemIdsOnPage?: any[]

          Array of item ids visible on the page

        • OptionalonSelect?: Function

          function to call when a selection is made

        • Optionalpreselected?: any[]

          Array of itemIds that should be selected when initialising

        • Optionalselected?: any[]

          Array of itemIds that should be currently selected. If it changes, the current selection will change

        • Optionaltotal?: number

          Number to show as total count

      Returns useBulkSelectReturn

      Functions and props to use for setting up bulk selection