From 1e65b71a9c17e75546ac2a430060cea5cbf6df57 Mon Sep 17 00:00:00 2001 From: James Klassen Date: Wed, 12 Jul 2023 09:15:30 -0500 Subject: [PATCH] update docs a bit --- components/skeleton/README.md | 17 +++++++++++++++++ .../skeleton/demo/skeleton-group-wrapper.js | 4 +--- 2 files changed, 18 insertions(+), 3 deletions(-) diff --git a/components/skeleton/README.md b/components/skeleton/README.md index 9f59abfbe9..1d32fddc0f 100644 --- a/components/skeleton/README.md +++ b/components/skeleton/README.md @@ -133,6 +133,23 @@ For example: When skeletized, this heading will take up `45%` of the available width. +## Skeleton groups +Skeleton groups can be used to ensure a collection of components all appear at the same time. This can be used to prevent individual components from popping in before everything has loaded. + +```js +import { SkeletonGroupMixin } from '@brightspace-ui/core/skeleton/skeleton-group-mixin.js'; + +class MyElement extends SkeletonGroupMixin(LitElement) { + + render() { + return html` + // Anything that can be skeletonized. + // All components will remain in skeleton state until they have all loaded + `; + } +} +``` + ## Future Enhancements Looking for an enhancement not listed here? Is there a core component that should support skeletons but doesn't yet? Create a GitHub issue! diff --git a/components/skeleton/demo/skeleton-group-wrapper.js b/components/skeleton/demo/skeleton-group-wrapper.js index 99ebad7e1c..507ece2097 100644 --- a/components/skeleton/demo/skeleton-group-wrapper.js +++ b/components/skeleton/demo/skeleton-group-wrapper.js @@ -5,9 +5,7 @@ import { SkeletonGroupMixin } from '../skeleton-group-mixin.js'; class SkeletonGroupTestWrapper extends SkeletonGroupMixin(LitElement) { render() { - return html` - - `; + return html``; } } customElements.define('d2l-skeleton-group-test-wrapper', SkeletonGroupTestWrapper);