Skip to content

Commit 1210f51

Browse files
authored
docs: show component tokens default value (#32876)
Show default value of component tokens in styling tab to better understand their meanings.
1 parent b5e97a6 commit 1210f51

File tree

4 files changed

+13
-17
lines changed

4 files changed

+13
-17
lines changed

docs/src/app/pages/component-viewer/token-table.html

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@
2424
</mat-form-field>
2525

2626
<mat-form-field subscriptSizing="dynamic" appearance="outline">
27-
<mat-label>Filter by system token</mat-label>
28-
<input #systemTokenInput matInput [value]="systemTokenFilter()"
29-
(input)="systemTokenFilter.set(systemTokenInput.value)"/>
27+
<mat-label>Filter by default value</mat-label>
28+
<input #defaultValueInput matInput [value]="defaultValueFilter()"
29+
(input)="defaultValueFilter.set(defaultValueInput.value)"/>
3030
</mat-form-field>
3131

3232
<button mat-button (click)="reset()">Reset filters</button>
@@ -38,7 +38,7 @@
3838
<tr>
3939
<th>Name</th>
4040
<th class="docs-type-header">Type</th>
41-
<th class="docs-system-header">Based on system token</th>
41+
<th class="docs-value-header">Default value</th>
4242
</tr>
4343
</thead>
4444

@@ -47,13 +47,7 @@
4747
<tr>
4848
<td><token-name [name]="token.overridesName"/></td>
4949
<td>{{token.type | titlecase}}</td>
50-
<td>
51-
@if (token.derivedFrom) {
52-
<token-name [name]="token.derivedFrom"/>
53-
} @else {
54-
None
55-
}
56-
</td>
50+
<td>{{token.value}}</td>
5751
</tr>
5852
} @empty {
5953
<tr>

docs/src/app/pages/component-viewer/token-table.scss

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,6 @@ thead {
3232
width: 10%;
3333
}
3434

35-
.docs-system-header {
35+
.docs-value-header {
3636
width: 30%;
3737
}

docs/src/app/pages/component-viewer/token-table.ts

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ export interface Token {
2424
prefix: string;
2525
type: TokenType;
2626
derivedFrom?: string;
27+
value: string | number | null;
2728
}
2829

2930
@Component({
@@ -51,24 +52,24 @@ export class TokenTable {
5152

5253
protected readonly nameFilter = signal('');
5354
protected readonly typeFilter = signal<TokenType | null>(null);
54-
protected readonly systemTokenFilter = signal('');
55+
protected readonly defaultValueFilter = signal('');
5556
protected readonly types: TokenType[] = ['base', 'color', 'typography', 'density'];
5657
protected readonly filteredTokens = computed(() => {
5758
const name = this.nameFilter().trim().toLowerCase();
5859
const typeFilter = this.typeFilter();
59-
const systemTokenFilter = this.systemTokenFilter();
60+
const defaultValueFilter = this.defaultValueFilter();
6061

6162
return this.tokens().filter(
6263
token =>
6364
(!name || token.overridesName.toLowerCase().includes(name)) &&
6465
(!typeFilter || token.type === typeFilter) &&
65-
(!systemTokenFilter || token.derivedFrom?.toLowerCase().includes(systemTokenFilter)),
66+
(!defaultValueFilter || token.value?.toString().toLowerCase().includes(defaultValueFilter)),
6667
);
6768
});
6869

6970
protected reset() {
7071
this.nameFilter.set('');
7172
this.typeFilter.set(null);
72-
this.systemTokenFilter.set('');
73+
this.defaultValueFilter.set('');
7374
}
7475
}

tools/extract-tokens/extract-tokens.mts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ interface ExtractedToken {
1313
/** Type of the token (color, typography etc.) */
1414
type: 'color' | 'typography' | 'density' | 'base';
1515
/** Value of the token. */
16-
value: string | number;
16+
value: string | number | null;
1717
/** Name under which the token can be referred to inside the `overrides` mixin. */
1818
overridesName: string;
1919
}
@@ -142,6 +142,7 @@ function extractTokens(themePath: string): Token[] {
142142
overridesName: token.overridesName,
143143
// Set to `undefined` so the key gets dropped from the JSON if there's no value.
144144
derivedFrom: derivedFrom || undefined,
145+
value: token.value,
145146
};
146147
});
147148
}

0 commit comments

Comments
 (0)