Interface UserListProps<User>

Type Parameters

  • User

Hierarchy

  • UserListProps

Properties

Header List Provider StatusError

Properties

Header

Header: {
    left?: ReactNode;
    onPressHeaderLeft: (() => void);
    onPressHeaderRight: ((selectedUsers) => Promise<void>);
    right?: ReactNode;
    shouldActivateHeaderRight?: ((selectedUsers) => boolean);
}

Props for UserListModule.Header *

Type declaration

  • Optional left?: ReactNode
  • onPressHeaderLeft: (() => void)
      • (): void

      • Returns void

  • onPressHeaderRight: ((selectedUsers) => Promise<void>)
      • (selectedUsers): Promise<void>

      • Parameters

        • selectedUsers: User[]

        Returns Promise<void>

  • Optional right?: ReactNode
  • Optional shouldActivateHeaderRight?: ((selectedUsers) => boolean)
      • (selectedUsers): boolean

      • Parameters

        • selectedUsers: User[]

        Returns boolean

List

List: {
    ListEmptyComponent?: ReactElement<any, string | JSXElementConstructor<any>>;
    onLoadNext: (() => Promise<void>);
    onRefresh?: (() => Promise<void>);
    refreshing?: boolean;
    renderUser: ((user, selectedUsers, setSelectedUsers) => null | ReactElement<any, string | JSXElementConstructor<any>>);
    users: User[];
}

Props for UserListModule.List *

Type declaration

  • Optional ListEmptyComponent?: ReactElement<any, string | JSXElementConstructor<any>>

    List empty component *

  • onLoadNext: (() => Promise<void>)
      • (): Promise<void>

      • Load next user list *

        Returns Promise<void>

  • Optional onRefresh?: (() => Promise<void>)
      • (): Promise<void>

      • Refresh user list *

        Returns Promise<void>

  • Optional refreshing?: boolean

    Refreshing state *

  • renderUser: ((user, selectedUsers, setSelectedUsers) => null | ReactElement<any, string | JSXElementConstructor<any>>)
      • (user, selectedUsers, setSelectedUsers): null | ReactElement<any, string | JSXElementConstructor<any>>

      • Render user component *

        Parameters

        • user: User
        • selectedUsers: User[]
        • setSelectedUsers: Dispatch<SetStateAction<User[]>>

        Returns null | ReactElement<any, string | JSXElementConstructor<any>>

  • users: User[]

    User list from SendbirdChat SDK or Custom query Fragment.queryCreator *

Provider

Provider: {
    headerRight: ((selectedUsers) => string);
    headerTitle: string;
}

Props for UserListModule.Provider *

Type declaration

  • headerRight: ((selectedUsers) => string)
      • (selectedUsers): string

      • Parameters

        • selectedUsers: User[]

        Returns string

  • headerTitle: string

StatusError

StatusError: {
    onPressRetry: (() => void);
}

Type declaration

  • onPressRetry: (() => void)
      • (): void

      • Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc