@hackplan/polaris
Version:
Shopify’s product component library
193 lines (120 loc) • 4.37 kB
Markdown
---
name: Text style
category: Titles and text
platforms:
- android
- ios
- web
keywords:
- TextStyle
- typographic
- subdued
- strong
- negative
- positive
- cues
- enhancements
- type
- bold
- dollar
- increase
- decrease
- input
- fields
- android
- ios
---
# Text style
Text style enhances text with additional visual meaning. For example, using subdued text to de-emphasize it from its surrounding text.
---
## Best practices
Text style should be:
- Used when enhancing the text to help merchants understand its meaning
- Subdued if the text is less important than its surrounding text
- Strong for input fields, or for a row total in a price table
- Paired with symbols, like an arrow or dollar sign, when using positive or negative styles
---
## Examples
### Subdued text style
Use to de-emphasize a piece of text that is less important to merchants than other nearby text. May also be used to indicate when normal content is absent, for example, “No supplier listed”. Don’t use only for aesthetic effect.
```jsx
<TextStyle variation="subdued">No supplier listed</TextStyle>
```
<!-- content-for: android -->
<!-- /content-for -->
<!-- content-for: ios -->
<!-- /content-for -->
### Strong text style
Use to mark text representing user input, or to emphasize the totals row in a price table.
```jsx
<TextStyle variation="strong">Total</TextStyle>
```
<!-- content-for: android -->
<!-- /content-for -->
<!-- content-for: ios -->
<!-- /content-for -->
### Positive text style
Use in combination with a symbol showing an increasing value to indicate an upward trend.
```jsx
<TextStyle variation="positive">Orders increased</TextStyle>
```
<!-- content-for: android -->
<!-- /content-for -->
<!-- content-for: ios -->
<!-- /content-for -->
### Negative text style
Use in combination with a symbol showing a decreasing value to indicate a downward trend.
```jsx
<TextStyle variation="negative">Orders decreased</TextStyle>
```
<!-- content-for: android -->
<!-- /content-for -->
<!-- content-for: ios -->
<!-- /content-for -->
### Code text style
Use to display inline snippets of code or code-like text.
```jsx
<p>
New URL that visitors should be forwarded to. If you want your store’s
homepage, enter <TextStyle variation="code"> / </TextStyle> (a forward slash).
</p>
```
<!-- content-for: android -->
<!-- /content-for -->
<!-- content-for: ios -->
<!-- /content-for -->
---
## Accessibility
<!-- content-for: android -->
See Material Design and development documentation about accessibility for Android:
- [Accessible design on Android](https://material.io/design/usability/accessibility.html)
- [Accessible development on Android](https://developer.android.com/guide/topics/ui/accessibility/)
<!-- /content-for -->
<!-- content-for: ios -->
See Apple’s Human Interface Guidelines and API documentation about accessibility for iOS:
- [Accessible design on iOS](https://developer.apple.com/design/human-interface-guidelines/ios/app-architecture/accessibility/)
- [Accessible development on iOS](https://developer.apple.com/accessibility/ios/)
<!-- /content-for -->
<!-- content-for: web -->
Don’t rely on text style alone to convey information to merchants. Ensure that text styles are used to enhance the information provided in text.
<!-- usageblock -->
#### Do
```
<TextStyle variation="positive">Orders increased</TextStyle>
```
#### Don’t
```
<TextStyle variation="positive">Orders</TextStyle>
```
<!-- end -->
<!-- /content-for -->