Backstage
Docs
Github
Preparing search index...
@backstage/ui
UseTableCursorOptions
Interface UseTableCursorOptions<T, TFilter>
interface
UseTableCursorOptions
<
T
extends
TableItem
,
TFilter
=
unknown
>
{
filter
?:
TFilter
;
getData
:
(
params
:
CursorParams
<
TFilter
>
)
=>
Promise
<
CursorResponse
<
T
>
>
;
initialFilter
?:
TFilter
;
initialSearch
?:
string
;
initialSort
?:
SortDescriptor
;
mode
:
"cursor"
;
onFilterChange
?:
(
filter
:
TFilter
)
=>
void
;
onSearchChange
?:
(
search
:
string
)
=>
void
;
onSortChange
?:
(
sort
:
SortDescriptor
)
=>
void
;
paginationOptions
?:
Omit
<
PaginationOptions
,
"initialOffset"
>
;
search
?:
string
;
sort
?:
SortDescriptor
|
null
;
}
Type Parameters
T
extends
TableItem
TFilter
=
unknown
Hierarchy (
View Summary
)
QueryOptions
<
TFilter
>
UseTableCursorOptions
Index
Properties
filter?
get
Data
initial
Filter?
initial
Search?
initial
Sort?
mode
on
Filter
Change?
on
Search
Change?
on
Sort
Change?
pagination
Options?
search?
sort?
Properties
Optional
filter
filter
?:
TFilter
get
Data
getData
:
(
params
:
CursorParams
<
TFilter
>
)
=>
Promise
<
CursorResponse
<
T
>
>
Optional
initial
Filter
initialFilter
?:
TFilter
Optional
initial
Search
initialSearch
?:
string
Optional
initial
Sort
initialSort
?:
SortDescriptor
mode
mode
:
"cursor"
Optional
on
Filter
Change
onFilterChange
?:
(
filter
:
TFilter
)
=>
void
Optional
on
Search
Change
onSearchChange
?:
(
search
:
string
)
=>
void
Optional
on
Sort
Change
onSortChange
?:
(
sort
:
SortDescriptor
)
=>
void
Optional
pagination
Options
paginationOptions
?:
Omit
<
PaginationOptions
,
"initialOffset"
>
Optional
search
search
?:
string
Optional
sort
sort
?:
SortDescriptor
|
null
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
filter
get
Data
initial
Filter
initial
Search
initial
Sort
mode
on
Filter
Change
on
Search
Change
on
Sort
Change
pagination
Options
search
sort
Docs
Github
Backstage
Loading...