mirror of
https://github.com/angular/angular.git
synced 2026-09-14 13:54:52 +08:00
docs: add badge example and fix some tree docs formatting (#11104)
This commit is contained in:
committed by
Joey Perrott
parent
376cb66b1d
commit
1071680f7a
+22
-22
@@ -16,11 +16,11 @@ list of items from hierarchical data. The "level" of each tree node is read thro
|
||||
method of the `TreeControl`; this level can be used to style the node such that it is indented to
|
||||
the appropriate level.
|
||||
|
||||
```
|
||||
```html
|
||||
<cdk-tree>
|
||||
<cdk-tree-node> parent node </cdk-tree-node>
|
||||
<cdk-tree-node> -- child node1 </cdk-tree-node>
|
||||
<cdk-tree-node> -- child node2 </cdk-tree-node>
|
||||
<cdk-tree-node> parent node </cdk-tree-node>
|
||||
<cdk-tree-node> -- child node1 </cdk-tree-node>
|
||||
<cdk-tree-node> -- child node2 </cdk-tree-node>
|
||||
</cdk-tree>
|
||||
|
||||
```
|
||||
@@ -36,13 +36,13 @@ variations, such as infinite or virtual scrolling.
|
||||
In nested tree, children nodes are placed inside their parent node in DOM. The parent node contains
|
||||
a node outlet into which children are projected.
|
||||
|
||||
```
|
||||
```html
|
||||
<cdk-tree>
|
||||
<cdk-nested-tree-node>
|
||||
parent node
|
||||
<cdk-nested-tree-node> -- child node1 </cdk-tree-node>
|
||||
<cdk-nested-tree-node> -- child node2 </cdk-tree-node>
|
||||
</cdk-nested-tree-node>
|
||||
<cdk-nested-tree-node>
|
||||
parent node
|
||||
<cdk-nested-tree-node> -- child node1 </cdk-tree-node>
|
||||
<cdk-nested-tree-node> -- child node2 </cdk-tree-node>
|
||||
</cdk-nested-tree-node>
|
||||
</cdk-tree>
|
||||
```
|
||||
|
||||
@@ -61,9 +61,9 @@ nested children nodes.
|
||||
A node definition is specified via any element with `cdkNodeDef`. This directive exports the node
|
||||
data to be used in any bindings in the node template.
|
||||
|
||||
```
|
||||
```html
|
||||
<cdk-tree-node *cdkNodeDef=“let node”>
|
||||
{{node.key}}: {{node.value}}
|
||||
{{node.key}}: {{node.value}}
|
||||
</cdk-tree-node>
|
||||
```
|
||||
|
||||
@@ -79,10 +79,10 @@ Spacing can be added either by applying the `cdkNodePadding` directive or by app
|
||||
When using nested tree nodes, the node template must contain a `cdkTreeNodeOutlet`, which marks
|
||||
where the children of the node will be rendered.
|
||||
|
||||
```
|
||||
```html
|
||||
<cdk-nested-tree-node *cdkNodeDef=“let node”>
|
||||
{{node.value}}
|
||||
<ng-container cdkTreeNodeOutlet></ng-container>
|
||||
{{node.value}}
|
||||
<ng-container cdkTreeNodeOutlet></ng-container>
|
||||
</cdk-nested-tree-node>
|
||||
|
||||
```
|
||||
@@ -93,7 +93,7 @@ A `cdkTreeNodeToggle` can be added in the tree node template to expand/collapse
|
||||
The toggle toggles the expand/collapse functions in TreeControl and is able to expand/collapse
|
||||
a tree node recursively by setting `[cdkTreeNodeToggleRecursive]` to true.
|
||||
|
||||
```
|
||||
```html
|
||||
<cdk-tree-node *cdkNodeDef=“let node” cdkTreeNodeToggle [cdkTreeNodeToggleRecursive]="true">
|
||||
{{node.value}}
|
||||
</cdk-tree-node>
|
||||
@@ -103,7 +103,7 @@ The toggle can be placed anywhere in the tree node, and is only toggled by click
|
||||
For best accessibility, `cdkTreeNodeToggle` should be on a button element and have an appropriate
|
||||
`aria-label`.
|
||||
|
||||
```
|
||||
```html
|
||||
<cdk-tree-node *cdkNodeDef=“let node”>
|
||||
<button cdkTreeNodeToggle aria-label="toggle tree node" [cdkTreeNodeToggleRecursive]="true">
|
||||
<mat-icon>expand</mat-icon>
|
||||
@@ -117,9 +117,9 @@ For best accessibility, `cdkTreeNodeToggle` should be on a button element and ha
|
||||
The cdkTreeNodePadding can be placed in a flat tree's node template to display the level
|
||||
information of a flat tree node.
|
||||
|
||||
```
|
||||
```html
|
||||
<cdk-tree-node *cdkNodeDef=“let node” cdkNodePadding>
|
||||
{{node.value}}
|
||||
{{node.value}}
|
||||
</cdk-tree-node>
|
||||
|
||||
```
|
||||
@@ -133,12 +133,12 @@ The tree may include multiple node templates, where a template is chosen
|
||||
for a particular data node via the `when` predicate of the template.
|
||||
|
||||
|
||||
```
|
||||
```html
|
||||
<cdk-tree-node *cdkNodeDef=“let node” cdkTreeNodePadding>
|
||||
{{node.value}}
|
||||
{{node.value}}
|
||||
</cdk-tree-node>
|
||||
<cdk-tree-node *cdkNodeDef=“let node; when: isSpecial” cdkTreeNodePadding>
|
||||
[ A special node {{node.value}} ]
|
||||
[ A special node {{node.value}} ]
|
||||
</cdk-tree-node>
|
||||
```
|
||||
|
||||
|
||||
+10
-2
@@ -1,5 +1,8 @@
|
||||
Badges are small status descriptors for UI elements. A badge consists of a small circle,
|
||||
typically containing a number or other short set of characters, that appears in proximity to another object.
|
||||
typically containing a number or other short set of characters, that appears in proximity to
|
||||
another object.
|
||||
|
||||
<!-- example(badge-overview) -->
|
||||
|
||||
### Badge position
|
||||
By default, the badge will be placed `above after`. The direction can be changed by defining
|
||||
@@ -50,4 +53,9 @@ background color to `primary`, `accent`, or `warn`.
|
||||
|
||||
### Accessibility
|
||||
Badges should be given a meaningful description via `matBadgeDescription`. This description will be
|
||||
applied, via `aria-describedby` to the element decorated by `matBadge`.
|
||||
applied, via `aria-describedby` to the element decorated by `matBadge`.
|
||||
|
||||
When applying a badge to a `<mat-icon>`, it is important to know that the icon is marked as
|
||||
`aria-hidden` by default. If the combination of icon and badge communicates some meaningful
|
||||
information, that information should be surfaced in another way. [See the guidance on indicator
|
||||
icons for more information](https://material.angular.io/components/icon/overview#indicator-icons).
|
||||
|
||||
@@ -16,11 +16,11 @@ node is read through the `getLevel` method of the `TreeControl`; this level can
|
||||
used to style the node such that it is indented to the appropriate level.
|
||||
|
||||
|
||||
```
|
||||
```html
|
||||
<mat-tree>
|
||||
<mat-tree-node> parent node </mat-tree-node>
|
||||
<mat-tree-node> -- child node1 </mat-tree-node>
|
||||
<mat-tree-node> -- child node2 </mat-tree-node>
|
||||
<mat-tree-node> parent node </mat-tree-node>
|
||||
<mat-tree-node> -- child node1 </mat-tree-node>
|
||||
<mat-tree-node> -- child node2 </mat-tree-node>
|
||||
</mat-tree>
|
||||
```
|
||||
|
||||
@@ -35,12 +35,12 @@ scrolling variations, such as infinite or virtual scrolling
|
||||
In Nested tree, children nodes are placed inside their parent node in DOM. The parent node has an
|
||||
outlet to keep all the children nodes.
|
||||
|
||||
```
|
||||
```html
|
||||
<mat-tree>
|
||||
<mat-nested-tree-node>
|
||||
parent node
|
||||
<mat-nested-tree-node> -- child node1 </mat-tree-node>
|
||||
<mat-nested-tree-node> -- child node2 </mat-tree-node>
|
||||
parent node
|
||||
<mat-nested-tree-node> -- child node1 </mat-tree-node>
|
||||
<mat-nested-tree-node> -- child node2 </mat-tree-node>
|
||||
</mat-nested-tree-node>
|
||||
</mat-tree>
|
||||
```
|
||||
|
||||
@@ -16,7 +16,7 @@ export interface StateGroup {
|
||||
styleUrls: ['./autocomplete-optgroup-example.css'],
|
||||
})
|
||||
|
||||
export class AutocompleteOptionGroupExample implements OnInit {
|
||||
export class AutocompleteOptgroupExample implements OnInit {
|
||||
stateForm: FormGroup = this.fb.group({
|
||||
stateGroup: '',
|
||||
});
|
||||
|
||||
@@ -0,0 +1 @@
|
||||
/** No CSS for this example */
|
||||
@@ -0,0 +1,17 @@
|
||||
<p>
|
||||
<span matBadge="4" matBadgeOverlap="false">Text with a badge</span>
|
||||
</p>
|
||||
|
||||
<p>
|
||||
Button with a badge on the left
|
||||
<button mat-raised-button color="primary"
|
||||
matBadge="8" matBadgePosition="before" matBadgeColor="accent">
|
||||
Action
|
||||
</button>
|
||||
</p>
|
||||
|
||||
<p>
|
||||
Icon with a badge
|
||||
<mat-icon matBadge="15" matBadgeColor="warn">home</mat-icon>
|
||||
</p>
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
import {Component} from '@angular/core';
|
||||
|
||||
|
||||
/**
|
||||
* @title Badge overview
|
||||
*/
|
||||
@Component({
|
||||
selector: 'badge-overview-example',
|
||||
templateUrl: 'badge-overview-example.html',
|
||||
styleUrls: ['badge-overview-example.css']
|
||||
})
|
||||
export class BadgeOverviewExample { }
|
||||
Reference in New Issue
Block a user