Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Components: Mark all experimental components in the handbook #32147

Merged
merged 1 commit into from
May 24, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions packages/components/src/box-control/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# BoxControl

<div class="callout callout-alert">
This feature is still experimental. “Experimental” means this is an early implementation subject to drastic and breaking changes.
</div>

BoxControl components let users set values for Top, Right, Bottom, and Left. This can be used as an input control for values like `padding` or `margin`.

## Usage
Expand Down
4 changes: 4 additions & 0 deletions packages/components/src/dimension-control/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# DimensionControl

<div class="callout callout-alert">
This feature is still experimental. “Experimental” means this is an early implementation subject to drastic and breaking changes.
</div>

`DimensionControl` is a component designed to provide a UI to control spacing and/or dimensions.

## Usage
Expand Down
4 changes: 4 additions & 0 deletions packages/components/src/divider/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Divider

<div class="callout callout-alert">
This feature is still experimental. “Experimental” means this is an early implementation subject to drastic and breaking changes.
</div>

`Divider` is a layout component that separates groups of related content.

## Usage
Expand Down
6 changes: 5 additions & 1 deletion packages/components/src/elevation/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Elevation

<div class="callout callout-alert">
This feature is still experimental. “Experimental” means this is an early implementation subject to drastic and breaking changes.
</div>

`Elevation` is a core component that renders shadow, using the component system's shadow system.

## Usage
Expand All @@ -10,7 +14,7 @@ The shadow effect is generated using the `value` prop.
import {
__experimentalElevation as Elevation,
__experimentalSurface as Surface,
__experimentalText as Text
__experimentalText as Text,
} from '@wordpress/components';

function Example() {
Expand Down
4 changes: 3 additions & 1 deletion packages/components/src/flex/flex-block/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# FlexBlock

> **Experimental!**
<div class="callout callout-alert">
This feature is still experimental. “Experimental” means this is an early implementation subject to drastic and breaking changes.
</div>

A layout component to contain items of a fixed width within `Flex`.

Expand Down
4 changes: 3 additions & 1 deletion packages/components/src/flex/flex-item/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# FlexItem

> **Experimental!**
<div class="callout callout-alert">
This feature is still experimental. “Experimental” means this is an early implementation subject to drastic and breaking changes.
</div>

A layout component to contain items of a fixed width within `Flex`.

Expand Down
4 changes: 3 additions & 1 deletion packages/components/src/flex/flex/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Flex

> **Experimental!**
<div class="callout callout-alert">
This feature is still experimental. “Experimental” means this is an early implementation subject to drastic and breaking changes.
</div>

`Flex` is a primitive layout component that adaptively aligns child content horizontally or vertically. `Flex` powers components like `HStack` and `VStack`.

Expand Down
6 changes: 4 additions & 2 deletions packages/components/src/grid/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Grid

> **Experimental!**
<div class="callout callout-alert">
This feature is still experimental. “Experimental” means this is an early implementation subject to drastic and breaking changes.
</div>

`Grid` is a primitive layout component that can arrange content in a grid configuration.

Expand All @@ -9,7 +11,7 @@
```jsx
import {
__experimentalGrid as Grid,
__experimentalText as Text
__experimentalText as Text,
} from '@wordpress/components';

function Example() {
Expand Down
6 changes: 4 additions & 2 deletions packages/components/src/h-stack/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# HStack

> **Experimental!**
<div class="callout callout-alert">
This feature is still experimental. “Experimental” means this is an early implementation subject to drastic and breaking changes.
</div>

`HStack` (Horizontal Stack) arranges child elements in a horizontal line.

Expand Down Expand Up @@ -93,7 +95,7 @@ function Example() {
<HStack>
<Text>Code</Text>
<Spacer>
<Text>is</Text>
<Text>is</Text>
</Spacer>
<Text>Poetry</Text>
</HStack>
Expand Down
4 changes: 3 additions & 1 deletion packages/components/src/heading/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Heading

> **Experimental!**
<div class="callout callout-alert">
This feature is still experimental. “Experimental” means this is an early implementation subject to drastic and breaking changes.
</div>

`Heading` renders headings and titles using the library's typography system.

Expand Down
4 changes: 4 additions & 0 deletions packages/components/src/input-control/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# InputControl

<div class="callout callout-alert">
This feature is still experimental. “Experimental” means this is an early implementation subject to drastic and breaking changes.
</div>

InputControl components let users enter and edit text. This is an experimental component intended to (in time) merge with or replace [TextControl](../text-control).

## Usage
Expand Down
4 changes: 4 additions & 0 deletions packages/components/src/navigation/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Navigation

<div class="callout callout-alert">
This feature is still experimental. “Experimental” means this is an early implementation subject to drastic and breaking changes.
</div>

Render a navigation list with optional groupings and hierarchy.

## Usage
Expand Down
4 changes: 4 additions & 0 deletions packages/components/src/number-control/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# NumberControl

<div class="callout callout-alert">
This feature is still experimental. “Experimental” means this is an early implementation subject to drastic and breaking changes.
</div>

NumberControl is an enhanced HTML [`input[type="number]`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/number) element.

## Usage
Expand Down
4 changes: 4 additions & 0 deletions packages/components/src/radio-group/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# RadioGroup

<div class="callout callout-alert">
This feature is still experimental. “Experimental” means this is an early implementation subject to drastic and breaking changes.
</div>

Use a RadioGroup component when you want users to select one option from a small set of options.

![RadioGroup component](https://wordpress.org/gutenberg/files/2018/12/s_96EC471FE9C9D91A996770229947AAB54A03351BDE98F444FD3C1BF0CED365EA_1541792995815_ButtonGroup.png)
Expand Down
10 changes: 5 additions & 5 deletions packages/components/src/spacer/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Spacer

> **Experimental!**
<div class="callout callout-alert">
This feature is still experimental. “Experimental” means this is an early implementation subject to drastic and breaking changes.
</div>

`Spacer` is a primitive layout component that providers inner (`padding`) or outer (`margin`) space in-between components. It can also be used to adaptively provide space within an `HStack` or `VStack`.

Expand All @@ -14,7 +16,7 @@
import {
__experimentalSpacer as Spacer,
__experimentalHeading as Heading,
__experimentalView as View
__experimentalView as View,
} from '@wordpress/components';

function Example() {
Expand All @@ -23,9 +25,7 @@ function Example() {
<Spacer>
<Heading>WordPress.org</Heading>
</Spacer>
<Text>
Code is Poetry
</Text>
<Text>Code is Poetry</Text>
</View>
);
}
Expand Down
4 changes: 3 additions & 1 deletion packages/components/src/text/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Text

> **Experimental!**
<div class="callout callout-alert">
This feature is still experimental. “Experimental” means this is an early implementation subject to drastic and breaking changes.
</div>

`Text` is a core component that renders text in the library, using the library's typography system.

Expand Down
5 changes: 4 additions & 1 deletion packages/components/src/tree-grid/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# TreeGrid (experimental)
# TreeGrid

<div class="callout callout-alert">
This feature is still experimental. “Experimental” means this is an early implementation subject to drastic and breaking changes.
</div>
## Table of contents

1. [Development guidelines](#development-guidelines)
Expand Down
4 changes: 3 additions & 1 deletion packages/components/src/truncate/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Truncate

> **Experimental!**
<div class="callout callout-alert">
This feature is still experimental. “Experimental” means this is an early implementation subject to drastic and breaking changes.
</div>

`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.

Expand Down
4 changes: 4 additions & 0 deletions packages/components/src/ui/card/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Card

<div class="callout callout-alert">
This feature is still experimental. “Experimental” means this is an early implementation subject to drastic and breaking changes.
</div>

`Card` groups similar concepts and tasks together. `Card`'s background is rendered with a `Surface`.

## Usage
Expand Down
4 changes: 4 additions & 0 deletions packages/components/src/ui/control-group/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# ControlGroup

<div class="callout callout-alert">
This feature is still experimental. “Experimental” means this is an early implementation subject to drastic and breaking changes.
</div>

`ControlGroup` is a layout-based component for rendering a group of control-based components, such as `Button`, `Select` or `TextInput`. Control components that render within `ControlGroup` automatically have their borders offset and border-radii rounded.

## Usage
Expand Down
4 changes: 4 additions & 0 deletions packages/components/src/ui/control-label/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# ControlLabel

<div class="callout callout-alert">
This feature is still experimental. “Experimental” means this is an early implementation subject to drastic and breaking changes.
</div>

`ControlLabel` is a form component that works with `FormGroup` to provide a label for form elements (e.g. `Switch` or `TextInput`).

## Usage
Expand Down
4 changes: 4 additions & 0 deletions packages/components/src/ui/form-group/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# FormGroup

<div class="callout callout-alert">
This feature is still experimental. “Experimental” means this is an early implementation subject to drastic and breaking changes.
</div>

`FormGroup` is a form component that groups a label with a form element (e.g. `Switch` or `TextInput`).

## Usage
Expand Down
4 changes: 4 additions & 0 deletions packages/components/src/ui/popover/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Popover

<div class="callout callout-alert">
This feature is still experimental. “Experimental” means this is an early implementation subject to drastic and breaking changes.
</div>

`Popover` is a component to render a floating content modal. It is similar in purpose to a tooltip, but renders content of any sort, not only simple text.

## Usage
Expand Down
4 changes: 4 additions & 0 deletions packages/components/src/ui/scrollable/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Scrollable

<div class="callout callout-alert">
This feature is still experimental. “Experimental” means this is an early implementation subject to drastic and breaking changes.
</div>

`Scrollable` is a layout component that content in a scrollable container.

## Usage
Expand Down
4 changes: 4 additions & 0 deletions packages/components/src/ui/spinner/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Spinner

<div class="callout callout-alert">
This feature is still experimental. “Experimental” means this is an early implementation subject to drastic and breaking changes.
</div>

`Spinner` is a component that notify users that their action is being processed.

## Usage
Expand Down
4 changes: 4 additions & 0 deletions packages/components/src/ui/surface/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Surface

<div class="callout callout-alert">
This feature is still experimental. “Experimental” means this is an early implementation subject to drastic and breaking changes.
</div>

`Surface` is a core component that renders a primary background color.

## Usage
Expand Down
4 changes: 4 additions & 0 deletions packages/components/src/ui/tooltip/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Tooltip

<div class="callout callout-alert">
This feature is still experimental. “Experimental” means this is an early implementation subject to drastic and breaking changes.
</div>

`Tooltip` is a component to render floating help text relative to a node when it receives focus or when the user places the mouse cursor atop it.

## Usage
Expand Down
4 changes: 4 additions & 0 deletions packages/components/src/ui/visually-hidden/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# VisuallyHidden

<div class="callout callout-alert">
This feature is still experimental. “Experimental” means this is an early implementation subject to drastic and breaking changes.
</div>

`VisuallyHidden` is a component used to render text intended to be visually hidden, but will show for alternate devices, for example a screen reader.

## Usage
Expand Down
4 changes: 4 additions & 0 deletions packages/components/src/unit-control/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# UnitControl

<div class="callout callout-alert">
This feature is still experimental. “Experimental” means this is an early implementation subject to drastic and breaking changes.
</div>

UnitControl allows the user to set a value as well as a unit (e.g. `px`).

## Usage
Expand Down
6 changes: 4 additions & 2 deletions packages/components/src/v-stack/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# VStack

> **Experimental!**
<div class="callout callout-alert">
This feature is still experimental. “Experimental” means this is an early implementation subject to drastic and breaking changes.
</div>

`VStack` (or Vertical Stack) is a layout component that arranges child elements in a vertical line.

Expand Down Expand Up @@ -93,7 +95,7 @@ function Example() {
<VStack>
<Text>Code</Text>
<Spacer>
<Text>is</Text>
<Text>is</Text>
</Spacer>
<Text>Poetry</Text>
</VStack>
Expand Down
6 changes: 4 additions & 2 deletions packages/components/src/view/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# View

> **Experimental!**
<div class="callout callout-alert">
This feature is still experimental. “Experimental” means this is an early implementation subject to drastic and breaking changes.
</div>

`View` is a core component that renders everything in the library. It is the principle component in the entire library.

Expand All @@ -11,7 +13,7 @@
```jsx
import {
__experimentalText as Text,
__experimentalView as View
__experimentalView as View,
} from '@wordpress/components';

function Example() {
Expand Down
4 changes: 3 additions & 1 deletion packages/components/src/z-stack/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# ZStack

> **Experimental!**
<div class="callout callout-alert">
This feature is still experimental. “Experimental” means this is an early implementation subject to drastic and breaking changes.
</div>

## Usage

Expand Down