@aurodesignsystem-dev/auro-table 0.0.0-pr160.0 → 0.0.0-pr162.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/demo/api.md CHANGED
@@ -35,17 +35,14 @@ In order to have the component generate your table for you, you can pass data to
35
35
  This attribute takes an array of column headers to use, and accepts blank strings for empty columns. It does not support duplicate values, including empty strings, as each value is used as a key to project data into the table cells via the `componentData` attribute.
36
36
 
37
37
  Example:
38
- ```javascript
39
- ["Column 1", "Column 2", "Column 3"]
40
- ```
38
+ <pre class="language-javascript"><code class="language-javascript">["Column 1", "Column 2", "Column 3"]</code></pre>
41
39
 
42
40
  ### componentData
43
41
 
44
42
  This attribute takes an array of objects, with each object representing a row with data defined for each cell by specifying the matching column-header value.
45
43
 
46
44
  Example:
47
- ```javascript
48
- [
45
+ <pre class="language-javascript"><code class="language-javascript">[
49
46
  {
50
47
  "Column 1": "Column 1 Row 1 Value",
51
48
  "Column 2": "Column 2 Row 1 Value",
@@ -56,13 +53,12 @@ Example:
56
53
  "Column 2": "Column 2 Row 2 Value",
57
54
  "Column 3": "Column 3 Row 2 Value"
58
55
  }
59
- ]
60
- ```
56
+ ]</code></pre>
61
57
 
62
58
  <div class="exampleWrapper">
63
- <!-- AURO-GENERATED-CONTENT:START (FILE:src=../apiExamples/basic-attributes.html) -->
64
- <!-- The below content is automatically added from ../apiExamples/basic-attributes.html -->
65
- <auro-table
59
+ <!-- AURO-GENERATED-CONTENT:START (FILE:src=../apiExamples/basic-attributes.html) -->
60
+ <!-- The below content is automatically added from ../apiExamples/basic-attributes.html -->
61
+ <auro-table
66
62
  columnHeaders='["","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday","Sunday"]'
67
63
  componentData='[
68
64
  {"": "Dance class", "Monday": "5:00pm","Wednesday": "5:00pm" },
@@ -71,16 +67,15 @@ Example:
71
67
  {"": "Morning workout", "Monday": "8:00am", "Tuesday": "8:00am", "Wednesday": "8:00am", "Thursday": "8:00am", "Friday": "8:00am" }
72
68
  ]'
73
69
  >
74
- </auro-table>
75
- <!-- AURO-GENERATED-CONTENT:END -->
70
+ </auro-table>
71
+ <!-- AURO-GENERATED-CONTENT:END -->
76
72
  </div>
77
73
  <auro-accordion alignRight>
78
- <span slot="trigger">See code</span>
74
+ <span slot="trigger">See code</span>
79
75
  <!-- AURO-GENERATED-CONTENT:START (CODE:src=../apiExamples/basic-attributes.html) -->
80
76
  <!-- The below code snippet is automatically added from ../apiExamples/basic-attributes.html -->
81
77
 
82
- ```html
83
- <auro-table
78
+ <pre class="language-html"><code class="language-html">&lt;auro-table
84
79
  columnHeaders='["","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday","Sunday"]'
85
80
  componentData='[
86
81
  {"": "Dance class", "Monday": "5:00pm","Wednesday": "5:00pm" },
@@ -88,9 +83,8 @@ Example:
88
83
  {"": "Team meeting", "Wednesday": "10:00am" },
89
84
  {"": "Morning workout", "Monday": "8:00am", "Tuesday": "8:00am", "Wednesday": "8:00am", "Thursday": "8:00am", "Friday": "8:00am" }
90
85
  ]'
91
- >
92
- </auro-table>
93
- ```
86
+ &gt;
87
+ &lt;/auro-table&gt;</code></pre>
94
88
  <!-- AURO-GENERATED-CONTENT:END -->
95
89
  </auro-accordion>
96
90
 
@@ -99,133 +93,131 @@ Example:
99
93
  For more dynamic content, you can provide your own custom HTML5 `<table>` element inside the `auro-table` tag to be projected into the default slot and styled appropriately. The `auro-table` component will add any supporting classes needed for styling. Mutations to the table, such as adding and removing columns and cells, are supported.
100
94
 
101
95
  <div class="exampleWrapper">
102
- <!-- AURO-GENERATED-CONTENT:START (FILE:src=../apiExamples/basic-slot.html) -->
103
- <!-- The below content is automatically added from ../apiExamples/basic-slot.html -->
104
- <auro-table>
105
- <table>
106
- <thead>
107
- <tr>
108
- <th></th>
109
- <th>Monday</th>
110
- <th>Tuesday</th>
111
- <th>Wednesday</th>
112
- <th>Thursday</th>
113
- <th>Friday</th>
114
- <th>Saturday</th>
115
- <th>Sunday</th>
116
- </tr>
117
- </thead>
118
- <tbody>
119
- <tr>
120
- <td>Dance class</td>
121
- <td>5:00pm</td>
122
- <td></td>
123
- <td>5:00pm</td>
124
- <td></td>
125
- <td></td>
126
- <td></td>
127
- <td></td>
128
- </tr>
129
- <tr>
130
- <td>Night classes</td>
131
- <td></td>
132
- <td></td>
133
- <td></td>
134
- <td>7:00pm</td>
135
- <td>7:00pm</td>
136
- <td></td>
137
- <td></td>
138
- </tr>
139
- <tr>
140
- <td>Team meeting</td>
141
- <td></td>
142
- <td></td>
143
- <td>10:00am</td>
144
- <td></td>
145
- <td></td>
146
- <td></td>
147
- <td></td>
148
- </tr>
149
- <tr>
150
- <td>Morning workout</td>
151
- <td>8:00am</td>
152
- <td>8:00am</td>
153
- <td>8:00am</td>
154
- <td>8:00am</td>
155
- <td>8:00am</td>
156
- <td></td>
157
- <td></td>
158
- </tr>
159
- </tbody>
160
- </table>
161
- </auro-table>
162
- <!-- AURO-GENERATED-CONTENT:END -->
96
+ <!-- AURO-GENERATED-CONTENT:START (FILE:src=../apiExamples/basic-slot.html) -->
97
+ <!-- The below content is automatically added from ../apiExamples/basic-slot.html -->
98
+ <auro-table>
99
+ <table>
100
+ <thead>
101
+ <tr>
102
+ <th></th>
103
+ <th>Monday</th>
104
+ <th>Tuesday</th>
105
+ <th>Wednesday</th>
106
+ <th>Thursday</th>
107
+ <th>Friday</th>
108
+ <th>Saturday</th>
109
+ <th>Sunday</th>
110
+ </tr>
111
+ </thead>
112
+ <tbody>
113
+ <tr>
114
+ <td>Dance class</td>
115
+ <td>5:00pm</td>
116
+ <td></td>
117
+ <td>5:00pm</td>
118
+ <td></td>
119
+ <td></td>
120
+ <td></td>
121
+ <td></td>
122
+ </tr>
123
+ <tr>
124
+ <td>Night classes</td>
125
+ <td></td>
126
+ <td></td>
127
+ <td></td>
128
+ <td>7:00pm</td>
129
+ <td>7:00pm</td>
130
+ <td></td>
131
+ <td></td>
132
+ </tr>
133
+ <tr>
134
+ <td>Team meeting</td>
135
+ <td></td>
136
+ <td></td>
137
+ <td>10:00am</td>
138
+ <td></td>
139
+ <td></td>
140
+ <td></td>
141
+ <td></td>
142
+ </tr>
143
+ <tr>
144
+ <td>Morning workout</td>
145
+ <td>8:00am</td>
146
+ <td>8:00am</td>
147
+ <td>8:00am</td>
148
+ <td>8:00am</td>
149
+ <td>8:00am</td>
150
+ <td></td>
151
+ <td></td>
152
+ </tr>
153
+ </tbody>
154
+ </table>
155
+ </auro-table>
156
+ <!-- AURO-GENERATED-CONTENT:END -->
163
157
  </div>
164
158
  <auro-accordion alignRight>
165
- <span slot="trigger">See code</span>
159
+ <span slot="trigger">See code</span>
166
160
  <!-- AURO-GENERATED-CONTENT:START (CODE:src=../apiExamples/basic-slot.html) -->
167
161
  <!-- The below code snippet is automatically added from ../apiExamples/basic-slot.html -->
168
162
 
169
- ```html
170
- <auro-table>
171
- <table>
172
- <thead>
173
- <tr>
174
- <th></th>
175
- <th>Monday</th>
176
- <th>Tuesday</th>
177
- <th>Wednesday</th>
178
- <th>Thursday</th>
179
- <th>Friday</th>
180
- <th>Saturday</th>
181
- <th>Sunday</th>
182
- </tr>
183
- </thead>
184
- <tbody>
185
- <tr>
186
- <td>Dance class</td>
187
- <td>5:00pm</td>
188
- <td></td>
189
- <td>5:00pm</td>
190
- <td></td>
191
- <td></td>
192
- <td></td>
193
- <td></td>
194
- </tr>
195
- <tr>
196
- <td>Night classes</td>
197
- <td></td>
198
- <td></td>
199
- <td></td>
200
- <td>7:00pm</td>
201
- <td>7:00pm</td>
202
- <td></td>
203
- <td></td>
204
- </tr>
205
- <tr>
206
- <td>Team meeting</td>
207
- <td></td>
208
- <td></td>
209
- <td>10:00am</td>
210
- <td></td>
211
- <td></td>
212
- <td></td>
213
- <td></td>
214
- </tr>
215
- <tr>
216
- <td>Morning workout</td>
217
- <td>8:00am</td>
218
- <td>8:00am</td>
219
- <td>8:00am</td>
220
- <td>8:00am</td>
221
- <td>8:00am</td>
222
- <td></td>
223
- <td></td>
224
- </tr>
225
- </tbody>
226
- </table>
227
- </auro-table>
228
- ```
163
+ <pre class="language-html"><code class="language-html">&lt;auro-table&gt;
164
+ &lt;table&gt;
165
+ &lt;thead&gt;
166
+ &lt;tr&gt;
167
+ &lt;th&gt;&lt;/th&gt;
168
+ &lt;th&gt;Monday&lt;/th&gt;
169
+ &lt;th&gt;Tuesday&lt;/th&gt;
170
+ &lt;th&gt;Wednesday&lt;/th&gt;
171
+ &lt;th&gt;Thursday&lt;/th&gt;
172
+ &lt;th&gt;Friday&lt;/th&gt;
173
+ &lt;th&gt;Saturday&lt;/th&gt;
174
+ &lt;th&gt;Sunday&lt;/th&gt;
175
+ &lt;/tr&gt;
176
+ &lt;/thead&gt;
177
+ &lt;tbody&gt;
178
+ &lt;tr&gt;
179
+ &lt;td&gt;Dance class&lt;/td&gt;
180
+ &lt;td&gt;5:00pm&lt;/td&gt;
181
+ &lt;td&gt;&lt;/td&gt;
182
+ &lt;td&gt;5:00pm&lt;/td&gt;
183
+ &lt;td&gt;&lt;/td&gt;
184
+ &lt;td&gt;&lt;/td&gt;
185
+ &lt;td&gt;&lt;/td&gt;
186
+ &lt;td&gt;&lt;/td&gt;
187
+ &lt;/tr&gt;
188
+ &lt;tr&gt;
189
+ &lt;td&gt;Night classes&lt;/td&gt;
190
+ &lt;td&gt;&lt;/td&gt;
191
+ &lt;td&gt;&lt;/td&gt;
192
+ &lt;td&gt;&lt;/td&gt;
193
+ &lt;td&gt;7:00pm&lt;/td&gt;
194
+ &lt;td&gt;7:00pm&lt;/td&gt;
195
+ &lt;td&gt;&lt;/td&gt;
196
+ &lt;td&gt;&lt;/td&gt;
197
+ &lt;/tr&gt;
198
+ &lt;tr&gt;
199
+ &lt;td&gt;Team meeting&lt;/td&gt;
200
+ &lt;td&gt;&lt;/td&gt;
201
+ &lt;td&gt;&lt;/td&gt;
202
+ &lt;td&gt;10:00am&lt;/td&gt;
203
+ &lt;td&gt;&lt;/td&gt;
204
+ &lt;td&gt;&lt;/td&gt;
205
+ &lt;td&gt;&lt;/td&gt;
206
+ &lt;td&gt;&lt;/td&gt;
207
+ &lt;/tr&gt;
208
+ &lt;tr&gt;
209
+ &lt;td&gt;Morning workout&lt;/td&gt;
210
+ &lt;td&gt;8:00am&lt;/td&gt;
211
+ &lt;td&gt;8:00am&lt;/td&gt;
212
+ &lt;td&gt;8:00am&lt;/td&gt;
213
+ &lt;td&gt;8:00am&lt;/td&gt;
214
+ &lt;td&gt;8:00am&lt;/td&gt;
215
+ &lt;td&gt;&lt;/td&gt;
216
+ &lt;td&gt;&lt;/td&gt;
217
+ &lt;/tr&gt;
218
+ &lt;/tbody&gt;
219
+ &lt;/table&gt;
220
+ &lt;/auro-table&gt;</code></pre>
229
221
  <!-- AURO-GENERATED-CONTENT:END -->
230
222
  </auro-accordion>
231
223
 
@@ -236,9 +228,9 @@ For more dynamic content, you can provide your own custom HTML5 `<table>` elemen
236
228
  The `nowrap` attribute, when applied, will prevent table content from word wrapping, i.e. all text content will be on a single line.
237
229
 
238
230
  <div class="exampleWrapper">
239
- <!-- AURO-GENERATED-CONTENT:START (FILE:src=../apiExamples/nowrap.html) -->
240
- <!-- The below content is automatically added from ../apiExamples/nowrap.html -->
241
- <auro-table
231
+ <!-- AURO-GENERATED-CONTENT:START (FILE:src=../apiExamples/nowrap.html) -->
232
+ <!-- The below content is automatically added from ../apiExamples/nowrap.html -->
233
+ <auro-table
242
234
  nowrap
243
235
  columnHeaders='["","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday","Sunday"]'
244
236
  componentData='[
@@ -248,15 +240,14 @@ The `nowrap` attribute, when applied, will prevent table content from word wrapp
248
240
  {"": "Morning workout", "Monday": "8:00am", "Tuesday": "8:00am", "Wednesday": "8:00am", "Thursday": "8:00am", "Friday": "8:00am" }
249
241
  ]'
250
242
  ></auro-table>
251
- <!-- AURO-GENERATED-CONTENT:END -->
243
+ <!-- AURO-GENERATED-CONTENT:END -->
252
244
  </div>
253
245
  <auro-accordion alignRight>
254
- <span slot="trigger">See code</span>
246
+ <span slot="trigger">See code</span>
255
247
  <!-- AURO-GENERATED-CONTENT:START (CODE:src=../apiExamples/nowrap.html) -->
256
248
  <!-- The below code snippet is automatically added from ../apiExamples/nowrap.html -->
257
249
 
258
- ```html
259
- <auro-table
250
+ <pre class="language-html"><code class="language-html">&lt;auro-table
260
251
  nowrap
261
252
  columnHeaders='["","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday","Sunday"]'
262
253
  componentData='[
@@ -265,8 +256,7 @@ The `nowrap` attribute, when applied, will prevent table content from word wrapp
265
256
  {"": "Team meeting", "Wednesday": "10:00am" },
266
257
  {"": "Morning workout", "Monday": "8:00am", "Tuesday": "8:00am", "Wednesday": "8:00am", "Thursday": "8:00am", "Friday": "8:00am" }
267
258
  ]'
268
- ></auro-table>
269
- ```
259
+ &gt;&lt;/auro-table&gt;</code></pre>
270
260
  <!-- AURO-GENERATED-CONTENT:END -->
271
261
  </auro-accordion>
272
262
 
@@ -277,12 +267,10 @@ The component may be restyled by changing the values of the following token(s).
277
267
  <!-- AURO-GENERATED-CONTENT:START (CODE:src=./../src/styles/tokens.scss) -->
278
268
  <!-- The below code snippet is automatically added from ./../src/styles/tokens.scss -->
279
269
 
280
- ```scss
281
- @use "@aurodesignsystem/design-tokens/dist/themes/alaska/SCSSVariables--alaska" as v;
282
-
270
+ <pre class="language-scss"><code class="language-scss">@use "@aurodesignsystem/design-tokens/dist/themes/alaska/SCSSVariables--alaska" as v;
271
+
283
272
  :host {
284
273
  --ds-auro-table-alt-row-container-color: var(--ds-basic-color-surface-neutral-subtle, #{v.$ds-basic-color-surface-neutral-subtle});
285
274
  --ds-auro-table-border-color: var(--ds-basic-color-border-subtle, #{v.$ds-basic-color-border-subtle});
286
- }
287
- ```
275
+ }</code></pre>
288
276
  <!-- AURO-GENERATED-CONTENT:END -->