Skip to content

Website: AdvancedTable max height argument docs #2872

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

Merged
merged 2 commits into from
May 14, 2025
Merged

Website: AdvancedTable max height argument docs #2872

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ebe3e1d
chore: update docs site
May 9, 2025
ebd5ffa
fix: clarify wording
May 14, 2025
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
8 changes: 0 additions & 8 deletions website/app/styles/pages/components/advanced-table.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,6 @@
// COMPONENTS > TABLE > ADVANCEDTABLE

#show-content-components-table-advanced-table {
.doc-advanced-table-scrollable-wrapper {
overflow-x: auto;
}

.doc-advanced-table-vertical-scrollable-wrapper {
height: 500px;
}

.doc-advanced-table-multiselect-with-pagination-demo {
.hds-advanced-table + .hds-pagination {
margin-top: 16px;
Expand Down
7 changes: 5 additions & 2 deletions website/docs/components/table/advanced-table/partials/code/component-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,8 +92,11 @@ The Advanced Table component itself is where most of the options will be applied
Determines if even-numbered rows will have a different background color from odd-numbered rows.<br><br>
**Important**: Advanced Table does **not** support setting `isStriped` to true when there are nested rows.
</C.Property>
<C.Property @name="hasStickyHeader" @type="boolean" @default="false">
Determines if the Advanced Table has a sticky header.
<C.Property @name="maxHeight" @type="string">
Sets the maximum height of the Advanced Table. If the `@maxHeight` is set, there will automatically be a sticky header. To turn off the sticky header and still have a max height, set `@hasStickyHeader` to false.
</C.Property>
<C.Property @name="hasStickyHeader" @type="boolean">
Determines if the Advanced Table has a sticky header. If set to `true`, must be used with the `@maxHeight` argument. If `@maxHeight` is set and `@hasStickyHeader` is `false`, there will not be a sticky header.
</C.Property>
<C.Property @name="hasStickyFirstColumn" @type="boolean" @default="false">
Determines if the Advanced Table has a sticky first column.
Expand Down
102 changes: 49 additions & 53 deletions website/docs/components/table/advanced-table/partials/code/how-to-use.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -382,31 +382,30 @@ We recommend using functionalities like [pagination](/components/pagination), [s

#### Vertical scrolling

For situations where the default number of rows visible may be high, it can be difficult for users to track which column is which once they scroll. In this case, the `hasStickyHeader` argument can be used to make the column headers persist as the user scrolls.
For situations where the default number of rows visible may be high, it can be difficult for users to track which column is which once they scroll. In this case, the `maxHeight` argument can be used to set the maximum height of the Advanced Table which will also add a sticky header. This will make the column headers persist as the user scrolls.

If you want to set the `maxHeight` but not have a sticky header, set `hasStickyHeader` to false.

```handlebars
<!-- this is an element with "height: 500px" -->
<div class="doc-advanced-table-vertical-scrollable-wrapper">
<Hds::AdvancedTable
@model={{this.demoDataWithLargeNumberOfRows}}
@columns={{array
(hash key="id" label="ID")
(hash key="name" label="Name" isSortable=true)
(hash key="email" label="Email")
(hash key="role" label="Role" isSortable=true)
}}
@hasStickyHeader={{true}}
>
<:body as |B|>
<B.Tr>
<B.Td>{{B.data.id}}</B.Td>
<B.Td>{{B.data.name}}</B.Td>
<B.Td>{{B.data.email}}</B.Td>
<B.Td>{{B.data.role}}</B.Td>
</B.Tr>
</:body>
</Hds::AdvancedTable>
</div>
<Hds::AdvancedTable
@model={{this.demoDataWithLargeNumberOfRows}}
@columns={{array
(hash key="id" label="ID")
(hash key="name" label="Name" isSortable=true)
(hash key="email" label="Email")
(hash key="role" label="Role" isSortable=true)
}}
@maxHeight="500px"
>
<:body as |B|>
<B.Tr>
<B.Td>{{B.data.id}}</B.Td>
<B.Td>{{B.data.name}}</B.Td>
<B.Td>{{B.data.email}}</B.Td>
<B.Td>{{B.data.role}}</B.Td>
</B.Tr>
</:body>
</Hds::AdvancedTable>
```

#### Horizontal scrolling
Expand All @@ -418,36 +417,33 @@ The component adds the sticky styles to the `[B].Th` component in each row. If t
Note: Using `@hasStickyFirstColumn` with nested rows is not supported.

```handlebars
<!-- this is an element with "overflow: auto" -->
<div class="doc-advanced-table-scrollable-wrapper">
<Hds::AdvancedTable
@hasStickyFirstColumn={{true}}
@model={{this.demoDataWithLargeNumberOfColumns}}
@columns={{array
(hash key="first_name" label="First Name" isSortable=true)
(hash key="last_name" label="Last Name" isSortable=true)
(hash key="age" label="Age" isSortable=true)
(hash key="email" label="Email")
(hash key="phone" label="Phone")
(hash key="bio" label="Biography" width="350px")
(hash key="education" label="Education Degree")
(hash key="occupation" label="Occupation")
}}
>
<:body as |B|>
<B.Tr>
<B.Th>{{B.data.first_name}}</B.Th>
<B.Td>{{B.data.last_name}}</B.Td>
<B.Td>{{B.data.age}}</B.Td>
<B.Td>{{B.data.email}}</B.Td>
<B.Td>{{B.data.phone}}</B.Td>
<B.Td>{{B.data.bio}}</B.Td>
<B.Td>{{B.data.education}}</B.Td>
<B.Td>{{B.data.occupation}}</B.Td>
</B.Tr>
</:body>
</Hds::AdvancedTable>
</div>
<Hds::AdvancedTable
@hasStickyFirstColumn={{true}}
@model={{this.demoDataWithLargeNumberOfColumns}}
@columns={{array
(hash key="first_name" label="First Name" isSortable=true)
(hash key="last_name" label="Last Name" isSortable=true)
(hash key="age" label="Age" isSortable=true)
(hash key="email" label="Email")
(hash key="phone" label="Phone")
(hash key="bio" label="Biography" width="350px")
(hash key="education" label="Education Degree")
(hash key="occupation" label="Occupation")
}}
>
<:body as |B|>
<B.Tr>
<B.Th>{{B.data.first_name}}</B.Th>
<B.Td>{{B.data.last_name}}</B.Td>
<B.Td>{{B.data.age}}</B.Td>
<B.Td>{{B.data.email}}</B.Td>
<B.Td>{{B.data.phone}}</B.Td>
<B.Td>{{B.data.bio}}</B.Td>
<B.Td>{{B.data.education}}</B.Td>
<B.Td>{{B.data.occupation}}</B.Td>
</B.Tr>
</:body>
</Hds::AdvancedTable>
```

### Multi-select Advanced Table
Expand Down