Paginator component description

Igx Parent

IgxGridComponent, IgxTreeGridComponent, IgxHierarchicalGridComponent, IgxPivotGridComponent, *

Type Parameters

Hierarchy

Hierarchy

  • Component<P & Omit<React.HTMLAttributes<HTMLElement>, keyof P>, {}>
    • IgrPaginator

Constructors

  • Type parameters

    Type Parameters

    Parameters

    • props: P & Omit<HTMLAttributes<HTMLElement>, keyof P>

    Returns IgrPaginator<P>

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<P & Omit<HTMLAttributes<HTMLElement>, keyof P>> & 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 isFirstPage(): boolean
  • Returns if the current page is the first page.

    const lastPage = this.paginator.isFirstPage;
    

    Returns boolean

  • get isLastPage(): boolean
  • Returns if the current page is the last page.

    const lastPage = this.paginator.isLastPage;
    

    Returns boolean

  • get name(): string
  • Returns string

  • set name(v): void
  • Parameters

    • v: string

    Returns void

  • get nativeElement(): HTMLElement
  • Returns HTMLElement

  • get page(): number
  • Gets/Sets the current page of the paginator. 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)

  • set pageChange(ev): void
  • Parameters

    Returns void

  • get perPage(): number
  • Gets/Sets the number of visible items per page in the paginator. 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)

  • set perPageChange(ev): void
  • Parameters

    Returns void

  • get selectOptions(): number[]
  • 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
  • Sets the total records.

    let totalRecords = this.paginator.totalRecords;
    

    Memberof

    IgxPaginatorComponent

    Returns number

  • set totalRecords(v): void
  • Parameters

    • v: number

    Returns void

Methods

  • Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes.

    Calling Component#setState generally does not trigger this method.

    This method will not stop working in React 17.

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

    Parameters

    • nextProps: Readonly<P & Omit<HTMLAttributes<HTMLElement>, keyof P>>
    • nextContext: any

    Returns void

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

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

  • 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

    • prevProps: Readonly<P & Omit<HTMLAttributes<HTMLElement>, keyof P>>
    • prevState: Readonly<{}>
    • Optional snapshot: any

    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

    • name: string

    Returns any

  • 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

    • prevProps: Readonly<P & Omit<HTMLAttributes<HTMLElement>, keyof P>>
    • prevState: Readonly<{}>

    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<{
        children: any[];
        className: (P & Omit<HTMLAttributes<HTMLElement>, keyof P>)["className"];
        ref: ((ref) => void);
        style: {};
    }, any>

  • Parameters

    • element: any

    Returns void

  • 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