@patternfly/patternfly
Version:
Assets, source, tooling, and content for PatternFly 4
98 lines (83 loc) • 3.67 kB
Markdown
---
id: Skeleton
section: components
cssPrefix: pf-c-skeleton
beta: true
---
import './Skeleton.css'
## Examples
### Default
```html
<div class="pf-c-skeleton"></div>
```
### Percentage width modifiers
```html
<div class="pf-c-skeleton pf-m-width-25"></div>
<br/>
<div class="pf-c-skeleton pf-m-width-33"></div>
<br/>
<div class="pf-c-skeleton pf-m-width-50"></div>
<br/>
<div class="pf-c-skeleton pf-m-width-66"></div>
<br/>
<div class="pf-c-skeleton pf-m-width-75"></div>
<br/>
<div class="pf-c-skeleton"></div>
```
### Percentage height modifiers
```html
<div class="pf-c-skeleton pf-m-height-25"></div>
<div class="pf-c-skeleton pf-m-height-33"></div>
<div class="pf-c-skeleton pf-m-height-50"></div>
<div class="pf-c-skeleton pf-m-height-66"></div>
<div class="pf-c-skeleton pf-m-height-75"></div>
<div class="pf-c-skeleton pf-m-height-100"></div>
```
### Text modifiers
```html
--pf-global--FontSize--4xl
<div class="pf-c-skeleton pf-m-text-4xl"></div>
<br/>--pf-global--FontSize--3xl
<div class="pf-c-skeleton pf-m-text-3xl"></div>
<br/>--pf-global--FontSize--2xl
<div class="pf-c-skeleton pf-m-text-2xl"></div>
<br/>--pf-global--FontSize--xl
<div class="pf-c-skeleton pf-m-text-xl"></div>
<br/>--pf-global--FontSize--lg
<div class="pf-c-skeleton pf-m-text-lg"></div>
<br/>--pf-global--FontSize--md
<div class="pf-c-skeleton pf-m-text-md"></div>
<br/>--pf-global--FontSize--sm
<div class="pf-c-skeleton pf-m-text-sm"></div>
```
### Static height width and shape modifiers
```html
Small circle
<div class="pf-c-skeleton pf-m-circle pf-m-width-sm"></div>
<br/>Medium circle
<div class="pf-c-skeleton pf-m-circle pf-m-width-md"></div>
<br/>Large circle
<div class="pf-c-skeleton pf-m-circle pf-m-width-lg"></div>
<br/>Small square
<div class="pf-c-skeleton pf-m-square pf-m-width-sm"></div>
<br/>Medium square
<div class="pf-c-skeleton pf-m-square pf-m-width-md"></div>
<br/>Large square
<div class="pf-c-skeleton pf-m-square pf-m-width-lg"></div>
<br/>Small rectangle
<div class="pf-c-skeleton pf-m-height-sm pf-m-width-md"></div>
<br/>Medium rectangle
<div class="pf-c-skeleton pf-m-height-md pf-m-width-lg"></div>
<br/>Large rectangle
<div class="pf-c-skeleton pf-m-height-lg"></div>
```
## Documentation
### Usage
| Class | Applied to | Outcome |
| ---------------------------------------------------- | ---------------- | ---------------------------------------------------------------------------------------------------- |
| `.pf-c-skeleton` | `<div>` | Initiates the skeleton component. **Required** |
| `.pf-m-width-[sm, md, lg, 25, 33, 50, 66, 75]` | `.pf-c-skeleton` | Modifies the width of the skeleton. The default is 100%. |
| `.pf-m-height-[sm, md, lg, 25, 33, 50, 66, 75, 100]` | `.pf-c-skeleton` | Modifies the height of the skeleton. The default is the inherited font size. |
| `.pf-m-text-[sm, md, lg, xl, 2xl, 3xl, 4xl]` | `.pf-c-skeleton` | Modifies the skeleton height to match the height of PatternFly's text elements. |
| `.pf-m-circle` | `.pf-c-skeleton` | Modifies the border radius of the skeleton to be a circle. Use a width modifier to specify the size. |
| `.pf-m-square` | `.pf-c-skeleton` | Modifies the border radius of the skeleton to be a square. Use a width modifier to specify the size. |