ScreenReaderTextProps

shouldAlertScreenReader

boolean


# ScreenReaderText

__You can provide text to TTS engines.__

## Usage

```tsx
import { ScreenReaderText } from '@kinsta/stratus'

const MyComponent = () => (
  <ScreenReaderText>
    This will happen here.
  </ScreenReaderText>
)
```

## Props

| Name                    | Type            | Description                                | Default |
|:------------------------|:----------------|:-------------------------------------------|:--------|
| children                | React.ReactNode | The content of the component               |         |
| shouldAlertScreenReader | boolean         | sets the <code>role</code> attribute of the component |         |

## Types

- <code>ScreenReaderTextProps</code>: props of the <code>ScreenReaderText</code> component processed by stratus
- <code>ScreenReaderTextInterface</code>:  <code>ScreenReaderTextProps</code> extended by <code>{`HTMLAttributes<HTMLDivElement>`}</code>

Read more about [types](/docs/user-guide/getting-started/types "Types") here

***


ScreenReaderText

#Usage

#Props

#Types