Skip to content

Commit 553aaa6

Browse files
asynclizcopybara-github
asyncliz
authored and
copybara-github
committed
docs: todo cleanup
PiperOrigin-RevId: 595708369
1 parent 043bbad commit 553aaa6

File tree

9 files changed

+92
-262
lines changed

9 files changed

+92
-262
lines changed

‎docs/components/chip.md

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -78,9 +78,9 @@ Choose the type of chip based on its purpose and author.
7878
text message replies.
7979

8080
<!-- no-catalog-start -->
81-
<!-- TODO: add image -->
81+
<!-- Need to add image -->
8282
<!-- no-catalog-end -->
83-
<!-- TODO: catalog-include "figures/<component>/usage.html" -->
83+
<!-- Need to add catalog-include "figures/<component>/usage.html" -->
8484

8585
```html
8686
<md-chip-set>
@@ -100,9 +100,9 @@ Chips should always appear in a set. Chip sets are
100100
that can display any type of chip or other toolbar items.
101101

102102
<!-- no-catalog-start -->
103-
<!-- TODO: add image -->
103+
<!-- Need to add image -->
104104
<!-- no-catalog-end -->
105-
<!-- TODO: catalog-include "figures/<component>/usage.html" -->
105+
<!-- Need to add catalog-include "figures/<component>/usage.html" -->
106106

107107
```html
108108
<h3>New event</h3>
@@ -119,9 +119,9 @@ All chips may display an optional icon. Input chips can specify if an avatar
119119
picture is displayed.
120120

121121
<!-- no-catalog-start -->
122-
<!-- TODO: add image -->
122+
<!-- Need to add image -->
123123
<!-- no-catalog-end -->
124-
<!-- TODO: catalog-include "figures/<component>/usage-scenario-one.html" -->
124+
<!-- Need to add catalog-include "figures/<component>/usage-scenario-one.html" -->
125125
<!-- catalog-only-end -->
126126

127127
```html
@@ -142,9 +142,9 @@ Assist, filter, and suggestion chips can be elevated if the placement requires
142142
protection, such as on top of an image.
143143

144144
<!-- no-catalog-start -->
145-
<!-- TODO: add image -->
145+
<!-- Need to add image -->
146146
<!-- no-catalog-end -->
147-
<!-- TODO: catalog-include "figures/<component>/usage-scenario-one.html" -->
147+
<!-- Need to add catalog-include "figures/<component>/usage-scenario-one.html" -->
148148
<!-- catalog-only-end -->
149149

150150
```html
@@ -208,9 +208,9 @@ Assist chips function as though the user asked an assistant to complete the
208208
action. They should appear dynamically and contextually in a UI.
209209

210210
<!-- no-catalog-start -->
211-
<!-- TODO: add image -->
211+
<!-- Need to add image -->
212212
<!-- no-catalog-end -->
213-
<!-- TODO: catalog-include "figures/<component>/usage-scenario-one.html" -->
213+
<!-- Need to add catalog-include "figures/<component>/usage-scenario-one.html" -->
214214
<!-- catalog-only-end -->
215215

216216
```html
@@ -234,9 +234,9 @@ use tags or descriptive words to filter content. They can be a good alternative
234234
to toggle buttons or checkboxes.
235235

236236
<!-- no-catalog-start -->
237-
<!-- TODO: add image -->
237+
<!-- Need to add image -->
238238
<!-- no-catalog-end -->
239-
<!-- TODO: catalog-include "figures/<component>/usage-scenario-one.html" -->
239+
<!-- Need to add catalog-include "figures/<component>/usage-scenario-one.html" -->
240240
<!-- catalog-only-end -->
241241

242242
```html
@@ -255,9 +255,9 @@ Filter chips can optionally be removable from the chip set. Removable chips have
255255
a trailing remove icon.
256256

257257
<!-- no-catalog-start -->
258-
<!-- TODO: add image -->
258+
<!-- Need to add image -->
259259
<!-- no-catalog-end -->
260-
<!-- TODO: catalog-include "figures/<component>/usage-scenario-one.html" -->
260+
<!-- Need to add catalog-include "figures/<component>/usage-scenario-one.html" -->
261261
<!-- catalog-only-end -->
262262

263263
```html
@@ -282,9 +282,9 @@ Input chips whose icons are user images may add the `avatar` attribute to
282282
display the image in a larger circle.
283283

284284
<!-- no-catalog-start -->
285-
<!-- TODO: add image -->
285+
<!-- Need to add image -->
286286
<!-- no-catalog-end -->
287-
<!-- TODO: catalog-include "figures/<component>/usage-scenario-one.html" -->
287+
<!-- Need to add catalog-include "figures/<component>/usage-scenario-one.html" -->
288288
<!-- catalog-only-end -->
289289

290290
```html
@@ -306,9 +306,9 @@ All input chips are removable. If an input chip does not have an action
306306
associated with clicking on it, it may be marked as `remove-only`.
307307

308308
<!-- no-catalog-start -->
309-
<!-- TODO: add image -->
309+
<!-- Need to add image -->
310310
<!-- no-catalog-end -->
311-
<!-- TODO: catalog-include "figures/<component>/usage-scenario-one.html" -->
311+
<!-- Need to add catalog-include "figures/<component>/usage-scenario-one.html" -->
312312
<!-- catalog-only-end -->
313313

314314
```html
@@ -328,9 +328,9 @@ help narrow a user’s intent by presenting dynamically generated suggestions,
328328
such as possible responses or search filters.
329329

330330
<!-- no-catalog-start -->
331-
<!-- TODO: add image -->
331+
<!-- Need to add image -->
332332
<!-- no-catalog-end -->
333-
<!-- TODO: catalog-include "figures/<component>/usage-scenario-one.html" -->
333+
<!-- Need to add catalog-include "figures/<component>/usage-scenario-one.html" -->
334334
<!-- catalog-only-end -->
335335

336336
```html
@@ -363,9 +363,9 @@ Token | Default value
363363
### Assist chip example
364364

365365
<!-- no-catalog-start -->
366-
<!-- TODO: add image -->
366+
<!-- Need to add image -->
367367
<!-- no-catalog-end -->
368-
<!-- TODO: catalog-include "figures/<component>/theming.html" -->
368+
<!-- Need to add catalog-include "figures/<component>/theming.html" -->
369369

370370
```html
371371
<style>
@@ -397,9 +397,9 @@ Token | Default value
397397
### Filter chip example
398398

399399
<!-- no-catalog-start -->
400-
<!-- TODO: add image -->
400+
<!-- Need to add image -->
401401
<!-- no-catalog-end -->
402-
<!-- TODO: catalog-include "figures/<component>/theming.html" -->
402+
<!-- Need to add catalog-include "figures/<component>/theming.html" -->
403403

404404
```html
405405
<style>
@@ -431,9 +431,9 @@ Token | Default value
431431
### Input chip example
432432

433433
<!-- no-catalog-start -->
434-
<!-- TODO: add image -->
434+
<!-- Need to add image -->
435435
<!-- no-catalog-end -->
436-
<!-- TODO: catalog-include "figures/<component>/theming.html" -->
436+
<!-- Need to add catalog-include "figures/<component>/theming.html" -->
437437

438438
```html
439439
<style>
@@ -464,9 +464,9 @@ Token | Default value
464464
### Suggestion chip example
465465

466466
<!-- no-catalog-start -->
467-
<!-- TODO: add image -->
467+
<!-- Need to add image -->
468468
<!-- no-catalog-end -->
469-
<!-- TODO: catalog-include "figures/<component>/theming.html" -->
469+
<!-- Need to add catalog-include "figures/<component>/theming.html" -->
470470

471471
```html
472472
<style>

‎docs/components/dialog.md

Lines changed: 5 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -78,23 +78,9 @@ action buttons.
7878
```
7979

8080
<!-- no-catalog-start -->
81-
<!-- TODO: add image -->
81+
<!-- Need to add image -->
8282
<!-- no-catalog-end -->
83-
<!-- catalog-only-start -->
84-
85-
<!--
86-
87-
<div class="figure-wrapper">
88-
<figure
89-
style="justify-content:center;"
90-
aria-label="">
91-
TODO: update figure
92-
</figure>
93-
</div>
94-
95-
-->
96-
97-
<!-- catalog-only-end -->
83+
<!-- Need to add catalog-include "figures/<component>/usage.html" -->
9884

9985
> Tip: use `margin`, `height`, and `width` CSS properties to control the
10086
> dialog's size and position.
@@ -200,23 +186,9 @@ Token | Default value
200186
### Example
201187

202188
<!-- no-catalog-start -->
203-
<!-- TODO: add image -->
189+
<!-- Need to add image -->
204190
<!-- no-catalog-end -->
205-
<!-- catalog-only-start -->
206-
207-
<!--
208-
209-
<div class="figure-wrapper">
210-
<figure
211-
style="justify-content:center;"
212-
aria-label="">
213-
TODO: update figure
214-
</figure>
215-
</div>
216-
217-
-->
218-
219-
<!-- catalog-only-end -->
191+
<!-- Need to add catalog-include "figures/<component>/usage.html" -->
220192

221193
```html
222194
<style>
@@ -254,7 +226,7 @@ Property | Attribute | Type | Default | Description
254226
--- | --- | --- | --- | ---
255227
`returnValue` | | `string` | `''` | Gets or sets the dialog's return value, usually to indicate which button a user pressed to close it.<br>https://developer.mozilla.org/en-US/docs/Web/API/HTMLDialogElement/returnValue
256228
`type` | `type` | `string` | `undefined` | The type of dialog for accessibility. Set this to `alert` to announce a dialog as an alert dialog.
257-
`open` | `open` | `boolean` | `undefined` |
229+
`open` | `open` | `boolean` | `undefined` |
258230
`getOpenAnimation` | | `() => DialogAnimation` | `function { ... }` | Gets the opening animation for a dialog. Set to a new function to customize the animation.
259231
`getCloseAnimation` | | `() => DialogAnimation` | `function { ... }` | Gets the closing animation for a dialog. Set to a new function to customize the animation.
260232

‎docs/components/list.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@ dirname: list
88

99
# Lists
1010

11-
<!-- TODO: update freshness to current date when copying. -->
12-
1311
<!--*
1412
# Document freshness: For more information, see go/fresh-source.
1513
freshness: { owner: 'emarquez' reviewed: '2023-08-09' }
@@ -360,8 +358,8 @@ Token | Default value
360358
--md-list-item-leading-image-shape: 25px;
361359
}
362360
img {
363-
width: 40px;
364-
}
361+
width: 40px;
362+
}
365363
</style>
366364
<md-list>
367365
<md-list-item headline="Wide Cat">
@@ -389,7 +387,7 @@ Token | Default value
389387

390388
Property | Attribute | Type | Default | Description
391389
--- | --- | --- | --- | ---
392-
`items` | | `ListItem[]` | `undefined` |
390+
`items` | | `ListItem[]` | `undefined` |
393391

394392
<!-- mdformat on(autogenerated might break rendering in catalog) -->
395393

@@ -425,7 +423,7 @@ Property | Attribute | Type | Default | Description
425423

426424
Event | Description
427425
--- | ---
428-
`request-activation` |
426+
`request-activation` |
429427

430428
<!-- mdformat on(autogenerated might break rendering in catalog) -->
431429

‎docs/components/progress.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ Progress indicators may be determinate to show progress, or indeterminate for an
7272
unspecified amount of progress.
7373

7474
<!-- no-catalog-start -->
75-
<!-- TODO: add image -->
75+
<!-- Need to add image -->
7676
<!-- no-catalog-end -->
7777
<!-- catalog-only-start -->
7878

@@ -112,7 +112,7 @@ Indeterminate progress indicators may cycle between four colors (primary,
112112
primary container, tertiary, and tertiary container by default).
113113

114114
<!-- no-catalog-start -->
115-
<!-- TODO: add image -->
115+
<!-- Need to add image -->
116116
<!-- no-catalog-end -->
117117
<!-- catalog-only-start -->
118118

@@ -157,7 +157,7 @@ Circular progress indicators display progress by animating along an invisible
157157
circular track in a clockwise direction.
158158

159159
<!-- no-catalog-start -->
160-
<!-- TODO: add image -->
160+
<!-- Need to add image -->
161161
<!-- no-catalog-end -->
162162
<!-- catalog-only-start -->
163163

@@ -190,7 +190,7 @@ Linear progress indicators display progress by animating along the length of a
190190
fixed, visible track.
191191

192192
<!-- no-catalog-start -->
193-
<!-- TODO: add image -->
193+
<!-- Need to add image -->
194194
<!-- no-catalog-end -->
195195
<!-- catalog-only-start -->
196196

@@ -222,7 +222,7 @@ indeterminate progress. The progress bar and track represent known progress
222222
while the buffer dots represent unknown progress.
223223

224224
<!-- no-catalog-start -->
225-
<!-- TODO: add image -->
225+
<!-- Need to add image -->
226226
<!-- no-catalog-end -->
227227
<!-- catalog-only-start -->
228228

0 commit comments

Comments
 (0)