Skip to content

Commit 2282d8f

Browse files
shleewhitedchyunKristinLBradleyandgen404jorytindall
authored
AdvancedTable: Website documentation (#2628)
Co-authored-by: Dylan Hyun <dylan.hyun@hashicorp.com> Co-authored-by: Kristin Bradley <kristin.bradley@hashicorp.com> Co-authored-by: Andrew Gendel <124841193+andgen404@users.noreply.github.com> Co-authored-by: Jory Tindall <jory.tindall@hashicorp.com> Co-authored-by: Heather Larsen <hlarsen@hashicorp.com> Co-authored-by: Majed <156002572+majedelass@users.noreply.github.com> Co-authored-by: LilithJames-HDS <lilith.james@hashicorp.com>
1 parent bc3b777 commit 2282d8f

File tree

67 files changed

+1843
-23
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

67 files changed

+1843
-23
lines changed

website/app/styles/app.scss

+1
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
@use "pages/foundations/icon" as foundations-icon;
3131
@use "pages/foundations/typography" as foundations-typography;
3232
@use "pages/components/accordion" as components-accordion;
33+
@use "pages/components/advanced-table" as components-advanced-table;
3334
@use "pages/components/alert" as components-alert;
3435
@use "pages/components/app-footer" as components-app-footer;
3536
@use "pages/components/application-state" as components-application-state;
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
/**
2+
* Copyright (c) HashiCorp, Inc.
3+
* SPDX-License-Identifier: MPL-2.0
4+
*/
5+
6+
// COMPONENTS > TABLE > ADVANCEDTABLE
7+
8+
#show-content-components-table-advanced-table {
9+
.doc-advanced-table-scrollable-wrapper {
10+
overflow-x: auto;
11+
}
12+
13+
.doc-advanced-table-vertical-scrollable-wrapper {
14+
max-height: 500px;
15+
overflow-y: auto;
16+
}
17+
18+
.doc-advanced-table-multiselect-with-pagination-demo {
19+
.hds-advanced-table + .hds-pagination {
20+
margin-top: 16px;
21+
}
22+
}
23+
}

website/app/styles/pages/components/table.scss

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
* SPDX-License-Identifier: MPL-2.0
44
*/
55

6-
// COMPONENTS > TABLE
6+
// COMPONENTS > TABLE > TABLE
77

8-
#show-content-components-table {
8+
#show-content-components-table-table {
99
.doc-table-valign-demo {
1010
display: flex;
1111
gap: 5px;

website/docs/components/copy/snippet/partials/guidelines/guidelines.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ The Copy Snippet comes in two colors: `primary` and `secondary`
2828

2929
!!! Do
3030

31-
When multiple Copy Snippets are needed in a single page, such as in a [Table](/components/table), consider using the `secondary` color to reduce the prominence of each Copy Snippet.
31+
When multiple Copy Snippets are needed in a single page, such as in a [Table](/components/table/table), consider using the `secondary` color to reduce the prominence of each Copy Snippet.
3232

3333
![Example of the Copy Snippet component in a table](/assets/components/copy/copy-snippet-table-do.png)
3434

website/docs/components/dropdown/partials/code/how-to-use.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Alternatively, pass `secondary` to `@color` to display a secondary button with a
5151

5252
#### ToggleIcon as overflow menu
5353

54-
Overflow menus are often found in the last column of a [Tables](/components/table). This is the only use case where it is acceptable to use
54+
Overflow menus are often found in the last column of a [Table](/components/table/table). This is the only use case where it is acceptable to use
5555
`@hasChevron={{false}}`. `@text` is still required, because it supplies the `aria-label` for ToggleIcon.
5656

5757
```handlebars

website/docs/components/dropdown/partials/guidelines/guidelines.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ ToggleIcons come in two sizes: **small** and **medium**.
7676

7777
!!! Info
7878

79-
While we provide a small size variant, we recommend only using this for the Overflow menu within [Tables](/components/table) because the icons and images start to become unrecognizable in smaller sizes.
79+
While we provide a small size variant, we recommend only using this for the Overflow menu within [Tables](/components/table/table) because the icons and images start to become unrecognizable in smaller sizes.
8080
!!!
8181

8282
<Doc::Layout @spacing="24px">
@@ -104,7 +104,7 @@ ToggleButtons require a visible chevron to indicate interactivity and provide di
104104

105105
![Example of open and closed dropdowns](/assets/components/dropdown/dropdown-button-chevrons.png =286x*)
106106

107-
We strongly recommend providing visible chevrons on most instances of ToggleIcons to indicate interactivity. That said, it’s common to see ToggleIcons that use the `more-horizontal` icon without chevrons. Their placement, usually in the last column of a [Table](/components/table), is typically indicative of this type of interaction.
107+
We strongly recommend providing visible chevrons on most instances of ToggleIcons to indicate interactivity. That said, it’s common to see ToggleIcons that use the `more-horizontal` icon without chevrons. Their placement, usually in the last column of a [Table](/components/table/table), is typically indicative of this type of interaction.
108108

109109
![Example of open and closed dropdowns](/assets/components/dropdown/dropdown-icon-chevrons.png =750x*)
110110

website/docs/components/pagination/index.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ links:
1010
github: >-
1111
https://github.com/hashicorp/design-system/tree/main/packages/components/src/components/hds/pagination
1212
related:
13-
- components/table
13+
- components/table/table
14+
- components/table/advanced-table
1415
- patterns/filter-patterns
1516
- patterns/table-multi-select
1617
previewImage: assets/illustrations/components/pagination.jpg

website/docs/components/pagination/partials/code/how-to-use.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ The reason for using a consumer-side function to determine the `query` argument
148148

149149
Even if the Pagination is based on routing, the `onPageChange/onPageSizeChange` callbacks are still available and can be used to respond to the users’ actions (eg. for logging, tracking, etc.).
150150

151-
Below you can find an example of an integration between the sortable [`Table`](/components/table) component and the `Pagination::Numbered` component that uses query parameters in the URL to preserve the UI state:
151+
Below you can find an example of an integration between the sortable [`Table`](/components/table/table) component and the `Pagination::Numbered` component that uses query parameters in the URL to preserve the UI state:
152152

153153
```handlebars
154154
<div class="doc-pagination-table-demo">
@@ -271,7 +271,7 @@ The reason for using a consumer-side function to determine the `query` argument
271271

272272
Even if the Pagination is based on routing, the `onPageChange/onPageSizeChange` callbacks are still available and can be used to respond to the users' actions (eg. for logging, tracking, etc.).
273273

274-
Below you can find an example of an integration between the [`Table`](/components/table) component and the `Pagination::Compact` component that uses query parameters in the URL to preserve the UI state:
274+
Below you can find an example of an integration between the [`Table`](/components/table/table) component and the `Pagination::Compact` component that uses query parameters in the URL to preserve the UI state:
275275

276276
```handlebars
277277
<div class="doc-pagination-table-demo">

0 commit comments

Comments
 (0)