Interface CustomListsProps

Hierarchy

Properties

FiltersEnabled? addAllCustomListEditorEntries? addCustomListEditorAdvSearchQuery? addCustomListEditorEntry? children? collections csrfToken customListEditorAutoUpdateStatus? customListEditorEntries? customListEditorIsAutoUpdateEnabled? customListEditorIsLoaded? customListEditorIsModified? customListEditorIsOwner? customListEditorIsSearchModified? customListEditorIsSharePending? customListEditorIsShared? customListEditorIsValid? customListEditorProperties? customListEditorSavedName? customListEditorSearchParams? deleteAllCustomListEditorEntries? deleteCustomList deleteCustomListEditorEntry? editOrCreate? executeCustomListEditorSearch? fetchCollections fetchCustomListDetails fetchCustomLists fetchError? fetchLanes fetchLanguages fetchLibraries identifier? isFetching isFetchingMoreCustomListEntries isFetchingMoreSearchResults isFetchingSearchResults key? lanes? languages? libraries? library listDetails? lists loadMoreEntries loadMoreSearchResults moveCustomListEditorAdvSearchQuery? openCustomListEditor ref? removeCustomListEditorAdvSearchQuery? resetCustomListEditor? saveCustomListEditor searchResults selectCustomListEditorAdvSearchQuery? shareCustomList? startingTitle? store? toggleCustomListEditorCollection? updateClearFiltersFlag? updateCustomListEditorAdvSearchQueryBoolean? updateCustomListEditorProperty? updateCustomListEditorSearchParam?

Properties

Optional FiltersEnabled

FiltersEnabled?: boolean

Optional addAllCustomListEditorEntries

addAllCustomListEditorEntries?: (() => void)

Type declaration

    • (): void

    • Returns void

Optional addCustomListEditorAdvSearchQuery

addCustomListEditorAdvSearchQuery?: ((builderName: string, query: AdvancedSearchQuery) => void)

Type declaration

Optional addCustomListEditorEntry

addCustomListEditorEntry?: ((id: string) => void)

Type declaration

    • (id: string): void

    • Parameters

      • id: string

      Returns void

Optional children

children?: ReactNode

collections

collections: CollectionData[]

csrfToken

csrfToken: string

Optional customListEditorAutoUpdateStatus

customListEditorAutoUpdateStatus?: string

Optional customListEditorEntries

customListEditorEntries?: CustomListEditorEntriesData

Optional customListEditorIsAutoUpdateEnabled

customListEditorIsAutoUpdateEnabled?: boolean

Optional customListEditorIsLoaded

customListEditorIsLoaded?: boolean

Optional customListEditorIsModified

customListEditorIsModified?: boolean

Optional customListEditorIsOwner

customListEditorIsOwner?: boolean

Optional customListEditorIsSearchModified

customListEditorIsSearchModified?: boolean

Optional customListEditorIsSharePending

customListEditorIsSharePending?: boolean

Optional customListEditorIsShared

customListEditorIsShared?: boolean

Optional customListEditorIsValid

customListEditorIsValid?: boolean

Optional customListEditorProperties

customListEditorProperties?: CustomListEditorProperties

Optional customListEditorSavedName

customListEditorSavedName?: string

Optional customListEditorSearchParams

customListEditorSearchParams?: CustomListEditorSearchParams

Optional deleteAllCustomListEditorEntries

deleteAllCustomListEditorEntries?: (() => void)

Type declaration

    • (): void

    • Returns void

deleteCustomList

deleteCustomList: ((listId: string) => Promise<void>)

Type declaration

    • (listId: string): Promise<void>

    • Parameters

      • listId: string

      Returns Promise<void>

Optional deleteCustomListEditorEntry

deleteCustomListEditorEntry?: ((id: string) => void)

Type declaration

    • (id: string): void

    • Parameters

      • id: string

      Returns void

Optional editOrCreate

editOrCreate?: string

Optional executeCustomListEditorSearch

executeCustomListEditorSearch?: (() => void)

Type declaration

    • (): void

    • Returns void

fetchCollections

fetchCollections: (() => Promise<CollectionsData>)

Type declaration

fetchCustomListDetails

fetchCustomListDetails: ((listId: string) => Promise<CollectionData>)

Type declaration

    • (listId: string): Promise<CollectionData>

    • Parameters

      • listId: string

      Returns Promise<CollectionData>

fetchCustomLists

fetchCustomLists: (() => Promise<CustomListsData>)

Type declaration

Optional fetchError

fetchError?: FetchErrorData

fetchLanes

fetchLanes: (() => Promise<LanesData>)

Type declaration

fetchLanguages

fetchLanguages: (() => void)

Type declaration

    • (): void

    • Returns void

fetchLibraries

fetchLibraries: (() => void)

Type declaration

    • (): void

    • Returns void

Optional identifier

identifier?: string

isFetching

isFetching: boolean

isFetchingMoreCustomListEntries

isFetchingMoreCustomListEntries: boolean

isFetchingMoreSearchResults

isFetchingMoreSearchResults: boolean

isFetchingSearchResults

isFetchingSearchResults: boolean

Optional key

key?: Key

Optional lanes

lanes?: LaneData[]

Optional languages

languages?: LanguagesData

Optional libraries

libraries?: LibraryData[]

library

library: string

Optional listDetails

listDetails?: CollectionData

lists

lists: CustomListData[]

loadMoreEntries

loadMoreEntries: (() => void)

Type declaration

    • (): void

    • Returns void

loadMoreSearchResults

loadMoreSearchResults: (() => void)

Type declaration

    • (): void

    • Returns void

Optional moveCustomListEditorAdvSearchQuery

moveCustomListEditorAdvSearchQuery?: ((builderName: string, id: string, targetId: string) => void)

Type declaration

    • (builderName: string, id: string, targetId: string): void

    • Parameters

      • builderName: string
      • id: string
      • targetId: string

      Returns void

openCustomListEditor

openCustomListEditor: ((listId: string) => void)

Type declaration

    • (listId: string): void

    • Parameters

      • listId: string

      Returns void

Optional ref

ref?: LegacyRef<CustomListsProps>

Optional removeCustomListEditorAdvSearchQuery

removeCustomListEditorAdvSearchQuery?: ((builderName: string, id: string) => void)

Type declaration

    • (builderName: string, id: string): void

    • Parameters

      • builderName: string
      • id: string

      Returns void

Optional resetCustomListEditor

resetCustomListEditor?: (() => void)

Type declaration

    • (): void

    • Returns void

saveCustomListEditor

saveCustomListEditor: (() => Promise<void>)

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

searchResults

searchResults: CollectionData

Optional selectCustomListEditorAdvSearchQuery

selectCustomListEditorAdvSearchQuery?: ((builderName: string, id: string) => void)

Type declaration

    • (builderName: string, id: string): void

    • Parameters

      • builderName: string
      • id: string

      Returns void

Optional shareCustomList

shareCustomList?: ((listId: string) => Promise<void>)

Type declaration

    • (listId: string): Promise<void>

    • Parameters

      • listId: string

      Returns Promise<void>

Optional startingTitle

startingTitle?: string

Optional store

store?: Store<Object, UnknownAction, unknown>

Optional toggleCustomListEditorCollection

toggleCustomListEditorCollection?: ((id: number) => void)

Type declaration

    • (id: number): void

    • Parameters

      • id: number

      Returns void

Optional updateClearFiltersFlag

updateClearFiltersFlag?: ((builderName: string, value: boolean) => void)

Type declaration

    • (builderName: string, value: boolean): void

    • Parameters

      • builderName: string
      • value: boolean

      Returns void

Optional updateCustomListEditorAdvSearchQueryBoolean

updateCustomListEditorAdvSearchQueryBoolean?: ((builderName: string, id: string, bool: string) => void)

Type declaration

    • (builderName: string, id: string, bool: string): void

    • Parameters

      • builderName: string
      • id: string
      • bool: string

      Returns void

Optional updateCustomListEditorProperty

updateCustomListEditorProperty?: ((name: string, value: any) => void)

Type declaration

    • (name: string, value: any): void

    • Parameters

      • name: string
      • value: any

      Returns void

Optional updateCustomListEditorSearchParam

updateCustomListEditorSearchParam?: ((name: string, value: any) => void)

Type declaration

    • (name: string, value: any): void

    • Parameters

      • name: string
      • value: any

      Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc