From 4bc50920b56a710efcffc08e79d2f3dfbcd5828c Mon Sep 17 00:00:00 2001 From: Sara Marcondes Date: Wed, 20 Jan 2021 15:32:55 -0800 Subject: [PATCH] Update truncate and view READMEs --- packages/components/src/truncate/README.md | 35 ------------------ packages/components/src/view/README.md | 43 ---------------------- 2 files changed, 78 deletions(-) diff --git a/packages/components/src/truncate/README.md b/packages/components/src/truncate/README.md index 151cd6eacfbae..695fae86d35a2 100644 --- a/packages/components/src/truncate/README.md +++ b/packages/components/src/truncate/README.md @@ -1,33 +1,7 @@ ---- -title: Truncate -description: 'Truncate is a typography primitive that trims text content.' -type: typography -slug: /components/truncate/ -keywords: ['truncate', 'text', 'ellipsis', 'trim', 'clip'] ---- - # Truncate `Truncate` is a typography primitive that trims text content. For almost all cases, it is recommended that `Text`, `Heading`, or `Subheading` is used to render text content. However, `Truncate` is available for custom implementations. -## Table of contents - - - - -- [Usage](#usage) -- [Props](#props) -- [See Also](#see-also) - - - - - - - - - - ## Usage ```jsx live @@ -90,12 +64,3 @@ function Example() { ); } ``` - - - - -## See Also - -- [`Text`](../text/) -- [`Heading`](../heading/) -- [`Subheading`](../subheading/) diff --git a/packages/components/src/view/README.md b/packages/components/src/view/README.md index e1efc4de88f17..ec265056ca408 100644 --- a/packages/components/src/view/README.md +++ b/packages/components/src/view/README.md @@ -1,36 +1,9 @@ ---- -title: View -description: 'View is the core component that renders everything in the library. It is the principle component in the entire library.' -type: layout -slug: /components/view/ -keywords: ['view', 'base', 'div', 'box', 'core', 'element', 'ui'] ---- - # View `View` is a core component that renders everything in the library. It is the principle component in the entire library. Note that `View` is not exported from components, it's fully internal. **Everything** is a `View`, and a `View` is **everything**. -## Table of contents - - - - -- [Usage](#usage) -- [Props](#props) -- [Styling](#styling) - - [Presets](#presets) - - - - - - - - - - ## Usage ```jsx live @@ -47,13 +20,6 @@ function Example() { ## Props -##### \_\_\_css - -**Type**: `InterpolatedCSS` - -Render custom CSS using the style system. The `cx` prop combines custom styling with the `css` prop. -Typically used "internally" to establish based styles for a `View`. - ##### as **Type**: `string`,`E` @@ -66,15 +32,6 @@ Render the component as another React Component or HTML Element. Render custom CSS using the style system. -##### cx - -**Type**: `any` - -Combines classNames as well as CSS style rules created with the `css` function. - - - - ## Styling ### Presets