Paginator component description

Igx Parent

IgxGridComponent, IgxTreeGridComponent, IgxHierarchicalGridComponent, IgxPivotGridComponent, *

Hierarchy

Hierarchy

Constructors

Properties

context: any

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

static contextType = MyContext
// For TS pre-3.7:
context!: React.ContextType<typeof MyContext>
// For TS 3.7 and above:
declare context: React.ContextType<typeof MyContext>
props: Readonly<IIgrPaginatorProps> & Readonly<{
    children?: ReactNode;
}>
refs: {
    [key: string]: ReactInstance;
}

Type declaration

  • [key: string]: ReactInstance
state: Readonly<{}>
contextType?: Context<any>

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

type MyContext = number
const Ctx = React.createContext<MyContext>(0)

class Foo extends React.Component {
static contextType = Ctx
context!: React.ContextType<typeof Ctx>
render () {
return <>My context's value: {this.context}</>;
}
}

Accessors

  • get displayDensity(): DisplayDensity
  • Returns the theme of the component. The default theme is comfortable. Available options are comfortable, cosy, compact.

    let componentTheme = this.component.displayDensity;
    

    Returns DisplayDensity

  • set displayDensity(v): void
  • Parameters

    Returns void

  • get name(): string
  • Returns string

  • set name(v): void
  • Parameters

    • v: string

    Returns void

  • get page(): number
  • An

    Input

    property, sets current page of the IgxPaginatorComponent. The default is 0.

    let page = this.paginator.page;
    

    Memberof

    IgxPaginatorComponent

    Returns number

  • set page(v): void
  • Parameters

    • v: number

    Returns void

  • get pageChange(): ((s, e) => void)
  • Returns ((s, e) => void)

      • (s, e): void
      • Parameters

        Returns void

  • set pageChange(ev): void
  • Parameters

    • ev: ((s, e) => void)
        • (s, e): void
        • Parameters

          Returns void

    Returns void

  • get paging(): ((s, e) => void)
  • Returns ((s, e) => void)

  • set paging(ev): void
  • Parameters

    Returns void

  • get pagingDone(): ((s, e) => void)
  • Returns ((s, e) => void)

  • set pagingDone(ev): void
  • Parameters

    Returns void

  • get perPage(): number
  • An

    Input

    property, sets number of visible items per page in the IgxPaginatorComponent. The default is 15.

    let itemsPerPage = this.paginator.perPage;
    

    Memberof

    IgxPaginatorComponent

    Returns number

  • set perPage(v): void
  • Parameters

    • v: number

    Returns void

  • get perPageChange(): ((s, e) => void)
  • Returns ((s, e) => void)

      • (s, e): void
      • Parameters

        Returns void

  • set perPageChange(ev): void
  • Parameters

    • ev: ((s, e) => void)
        • (s, e): void
        • Parameters

          Returns void

    Returns void

  • get selectOptions(): number[]
  • An

    Input

    property that sets custom options in the select of the paginator

    let options = this.paginator.selectOptions;
    

    Memberof

    IgxPaginatorComponent

    Returns number[]

  • set selectOptions(v): void
  • Parameters

    • v: number[]

    Returns void

  • get totalPages(): number
  • Total pages calculated from totalRecords and perPage

    Returns number

  • set totalPages(v): void
  • Parameters

    • v: number

    Returns void

  • get totalRecords(): number
  • An

    Input

    property that sets the total records.

    let totalRecords = this.paginator.totalRecords;
    

    Memberof

    IgxPaginatorComponent

    Returns number

  • set totalRecords(v): void
  • Parameters

    • v: number

    Returns void

Methods

  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

  • Called immediately after updating occurs. Not called for the initial render.

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    Parameters

    Returns void

  • Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    Returns void

  • Parameters

    • Optional callback: (() => void)
        • (): void
        • Returns void

    Returns void

  • Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.

    Parameters

    Returns any

  • Goes to the next page of the IgxPaginatorComponent, if the paginator is not already at the last page.

    this.paginator.nextPage();
    

    Memberof

    IgxPaginatorComponent

    Returns void

  • Goes to the desired page index.

    this.paginator.paginate(1);
    

    val

    Memberof

    IgxPaginatorComponent

    Parameters

    • val: number

    Returns void

  • Goes to the previous page of the IgxPaginatorComponent, if the paginator is not already at the first page.

    this.paginator.previousPage();
    

    Memberof

    IgxPaginatorComponent

    Returns void

  • Returns DetailedReactHTMLElement<any, HTMLElement>

  • Type parameters

    Type Parameters

    • K extends never

    Parameters

    • state: {} | ((prevState, props) => {} | Pick<{}, K>) | Pick<{}, K>
    • Optional callback: (() => void)
        • (): void
        • Returns void

    Returns void

  • Parameters

    • nextProps: any
    • nextState: any

    Returns boolean