From 8e36280f599f2c4982eee13c4e863485db755394 Mon Sep 17 00:00:00 2001 From: Roman Fedorenkov <1071418+SeqviriouM@users.noreply.github.com> Date: Thu, 17 Aug 2023 22:49:12 +0300 Subject: [PATCH] docs(Skeleton): update README (#909) --- src/components/Skeleton/README.md | 21 +++++++++++++++------ 1 file changed, 15 insertions(+), 6 deletions(-) diff --git a/src/components/Skeleton/README.md b/src/components/Skeleton/README.md index 0380ebdb6d..f3aafdf599 100644 --- a/src/components/Skeleton/README.md +++ b/src/components/Skeleton/README.md @@ -1,9 +1,18 @@ -## Skeleton + -Component for illusion of fast loading. +# Skeleton -### PropTypes + -| Property | Type | Required | Default | Description | -| :-------- | :------- | :------- | :------ | :------------------------------------------ | -| className | `String` | | | Class name to customize size component size | +```tsx +import {Skeleton} from '@gravity-ui/uikit'; +``` + +The Skeleton component displays a placeholder preview of your content before the data gets loaded to reduce load-time frustration. + +## Properties + +| Property | Description | Default | +| :-------- | :----------------------------------------------------- | :------ | +| style | Custom CSS properties for root element `CSSProperties` | | +| className | Custom CSS class for root element `string` | |