Skip to content

docs: fixed API docs link #6054

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+16 −16
Open

docs: fixed API docs link #6054

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 16 additions & 16 deletions packages/table-core/src/core/headers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,100 +109,100 @@ export interface CoreHeader<TData extends RowData, TValue> {
export interface HeadersInstance<TData extends RowData> {
/**
* Returns all header groups for the table.
* @link [API Docs](https://tanstack.com/table/v8/docs/api/core/headers#getheadergroups)
* @link [API Docs](https://tanstack.com/table/v8/docs/api/core/header#getheadergroups)
* @link [Guide](https://tanstack.com/table/v8/docs/guide/headers)
*/
getHeaderGroups: () => HeaderGroup<TData>[]
/**
* If pinning, returns the header groups for the left pinned columns.
* @link [API Docs](https://tanstack.com/table/v8/docs/api/core/headers#getleftheadergroups)
* @link [API Docs](https://tanstack.com/table/v8/docs/api/core/header#getleftheadergroups)
* @link [Guide](https://tanstack.com/table/v8/docs/guide/headers)
*/
getLeftHeaderGroups: () => HeaderGroup<TData>[]
/**
* If pinning, returns the header groups for columns that are not pinned.
* @link [API Docs](https://tanstack.com/table/v8/docs/api/core/headers#getcenterheadergroups)
* @link [API Docs](https://tanstack.com/table/v8/docs/api/core/header#getcenterheadergroups)
* @link [Guide](https://tanstack.com/table/v8/docs/guide/headers)
*/
getCenterHeaderGroups: () => HeaderGroup<TData>[]
/**
* If pinning, returns the header groups for the right pinned columns.
* @link [API Docs](https://tanstack.com/table/v8/docs/api/core/headers#getrightheadergroups)
* @link [API Docs](https://tanstack.com/table/v8/docs/api/core/header#getrightheadergroups)
* @link [Guide](https://tanstack.com/table/v8/docs/guide/headers)
*/
getRightHeaderGroups: () => HeaderGroup<TData>[]

/**
* Returns the footer groups for the table.
* @link [API Docs](https://tanstack.com/table/v8/docs/api/core/headers#getfootergroups)
* @link [API Docs](https://tanstack.com/table/v8/docs/api/core/header#getfootergroups)
* @link [Guide](https://tanstack.com/table/v8/docs/guide/headers)
*/
getFooterGroups: () => HeaderGroup<TData>[]
/**
* If pinning, returns the footer groups for the left pinned columns.
* @link [API Docs](https://tanstack.com/table/v8/docs/api/core/headers#getleftfootergroups)
* @link [API Docs](https://tanstack.com/table/v8/docs/api/core/header#getleftfootergroups)
* @link [Guide](https://tanstack.com/table/v8/docs/guide/headers)
*/
getLeftFooterGroups: () => HeaderGroup<TData>[]
/**
* If pinning, returns the footer groups for columns that are not pinned.
* @link [API Docs](https://tanstack.com/table/v8/docs/api/core/headers#getcenterfootergroups)
* @link [API Docs](https://tanstack.com/table/v8/docs/api/core/header#getcenterfootergroups)
* @link [Guide](https://tanstack.com/table/v8/docs/guide/headers)
*/
getCenterFooterGroups: () => HeaderGroup<TData>[]
/**
* If pinning, returns the footer groups for the right pinned columns.
* @link [API Docs](https://tanstack.com/table/v8/docs/api/core/headers#getrightfootergroups)
* @link [API Docs](https://tanstack.com/table/v8/docs/api/core/header#getrightfootergroups)
* @link [Guide](https://tanstack.com/table/v8/docs/guide/headers)
*/
getRightFooterGroups: () => HeaderGroup<TData>[]

/**
* Returns headers for all columns in the table, including parent headers.
* @link [API Docs](https://tanstack.com/table/v8/docs/api/core/headers#getflatheaders)
* @link [API Docs](https://tanstack.com/table/v8/docs/api/core/header#getflatheaders)
* @link [Guide](https://tanstack.com/table/v8/docs/guide/headers)
*/
getFlatHeaders: () => Header<TData, unknown>[]
/**
* If pinning, returns headers for all left pinned columns in the table, including parent headers.
* @link [API Docs](https://tanstack.com/table/v8/docs/api/core/headers#getleftflatheaders)
* @link [API Docs](https://tanstack.com/table/v8/docs/api/core/header#getleftflatheaders)
* @link [Guide](https://tanstack.com/table/v8/docs/guide/headers)
*/
getLeftFlatHeaders: () => Header<TData, unknown>[]
/**
* If pinning, returns headers for all columns that are not pinned, including parent headers.
* @link [API Docs](https://tanstack.com/table/v8/docs/api/core/headers#getcenterflatheaders)
* @link [API Docs](https://tanstack.com/table/v8/docs/api/core/header#getcenterflatheaders)
* @link [Guide](https://tanstack.com/table/v8/docs/guide/headers)
*/
getCenterFlatHeaders: () => Header<TData, unknown>[]
/**
* If pinning, returns headers for all right pinned columns in the table, including parent headers.
* @link [API Docs](https://tanstack.com/table/v8/docs/api/core/headers#getrightflatheaders)
* @link [API Docs](https://tanstack.com/table/v8/docs/api/core/header#getrightflatheaders)
* @link [Guide](https://tanstack.com/table/v8/docs/guide/headers)
*/
getRightFlatHeaders: () => Header<TData, unknown>[]

/**
* Returns headers for all leaf columns in the table, (not including parent headers).
* @link [API Docs](https://tanstack.com/table/v8/docs/api/core/headers#getleafheaders)
* @link [API Docs](https://tanstack.com/table/v8/docs/api/core/header#getleafheaders)
* @link [Guide](https://tanstack.com/table/v8/docs/guide/headers)
*/
getLeafHeaders: () => Header<TData, unknown>[]
/**
* If pinning, returns headers for all left pinned leaf columns in the table, (not including parent headers).
* @link [API Docs](https://tanstack.com/table/v8/docs/api/core/headers#getleftleafheaders)
* @link [API Docs](https://tanstack.com/table/v8/docs/api/core/header#getleftleafheaders)
* @link [Guide](https://tanstack.com/table/v8/docs/guide/headers)
*/
getLeftLeafHeaders: () => Header<TData, unknown>[]
/**
* If pinning, returns headers for all columns that are not pinned, (not including parent headers).
* @link [API Docs](https://tanstack.com/table/v8/docs/api/core/headers#getcenterleafheaders)
* @link [API Docs](https://tanstack.com/table/v8/docs/api/core/header#getcenterleafheaders)
* @link [Guide](https://tanstack.com/table/v8/docs/guide/headers)
*/
getCenterLeafHeaders: () => Header<TData, unknown>[]
/**
* If pinning, returns headers for all right pinned leaf columns in the table, (not including parent headers).
* @link [API Docs](https://tanstack.com/table/v8/docs/api/core/headers#getrightleafheaders)
* @link [API Docs](https://tanstack.com/table/v8/docs/api/core/header#getrightleafheaders)
* @link [Guide](https://tanstack.com/table/v8/docs/guide/headers)
*/
getRightLeafHeaders: () => Header<TData, unknown>[]
Expand Down