import { ArgTypes, Meta, Canvas } from '@storybook/addon-docs/blocks';
import * as ShapeIndicatorStories from './ShapeIndicator.stories';
import { stackblitzPrefillConfig } from '../../../previewer/codePreviewer';

<Meta isTemplate />

# ShapeIndicator

[Source code](https://github.com/carbon-design-system/carbon/tree/main/packages/react/src/components/ShapeIndicator)
&nbsp;

{/* <!-- START doctoc generated TOC please keep comment here to allow auto update --> <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> */}

## Table of Contents

- [Overview](#overview)
- [Kind](#kind)
- [Text Size](#text-size)
- [Customizing the label](#customizing-the-label)
- [Component API](#component-api)
- [Feedback](#feedback)

{/* <!-- END doctoc generated TOC please keep comment here to allow auto update --> */}

## Overview

`ShapeIndicator`

```jsx
import { preview__ShapeIndicator as ShapeIndicator } from '@carbon/react';

function ExampleComponent() {
  return (
    <ShapeIndicator kind="failed" label="Failed">
  );
}
```

<Canvas
  of={ShapeIndicatorStories.Default}
  additionalActions={[
    {
      title: 'Open in Stackblitz',
      onClick: () => stackblitzPrefillConfig(ShapeIndicatorStories.Default),
    },
  ]}
/>

## Kind

Shape indicators can take the form of failed, critical, high, medium, low,
cautious, undefined, stable, informative, incomplete, and draft.

## Text Size

Shape indicators have two text size options 12 and 14. The default is 12.

## Customizing the label

You can set a string to customize the label of the Shape indicator.

## Component API

<ArgTypes />

## Feedback

Help us improve this component by providing feedback, asking questions on Slack,
or updating this file on
[GitHub](https://github.com/carbon-design-system/carbon/edit/main/packages/react/src/components/ShapeIndicator/ShapeIndicator.mdx).
