Skip to content

Commit 06ada58

Browse files
author
Sara Dahan
committed
docs: update README with latest instructions
1 parent fb079ed commit 06ada58

File tree

1 file changed

+23
-4
lines changed

1 file changed

+23
-4
lines changed

elements/pf-label-group/README.md

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,30 @@
11
# Label Group
2-
# <pf-label-group>
3-
4-
A **label group** is a collection of labels that can be grouped by category and used to represent one or more values assigned to a single attribute.
2+
A label group is a collection of labels that can be grouped by category and used to represent one or more values assigned to a single attribute.
53
When the number of labels exceeds `numLabels`, additional labels are hidden under an overflow label.
64

5+
## Installation
6+
7+
Load `<pf-label-group>` via CDN:
8+
9+
```html
10+
<script src="https://jspm.dev/@patternfly/elements/pf-label-group/pf-label-group.js"></script>
11+
```
12+
13+
Or, if you are using [NPM](https://npm.im), install it
14+
15+
```bash
16+
npm install @patternfly/elements
17+
```
18+
19+
Then once installed, import it to your application:
20+
21+
```js
22+
import '@patternfly/elements/pf-label-group/pf-label-group.js';
23+
```
24+
725
---
8-
## Usage
26+
27+
## Usage
928

1029
```html
1130
<pf-label-group num-labels="2">

0 commit comments

Comments
 (0)