# bpk-component-text

> Backpack React Native text component.

## Default

| Day | Night |
| --- | --- |
| <img src="https://raw.githubusercontent.com/Skyscanner/backpack-react-native/main/screenshots/bpk-component-text/ios/default.png" alt="bpk-component-text default iPhone 8 simulator" width="375" /> | <img src="https://raw.githubusercontent.com/Skyscanner/backpack-react-native/main/screenshots/bpk-component-text/ios/default_dm.png" alt="bpk-component-text default iPhone 8 simulator - dark mode" width="375" /> |
| <img src="https://raw.githubusercontent.com/Skyscanner/backpack-react-native/main/screenshots/bpk-component-text/android/default.png" alt="bpk-component-text default Google Pixel emulator" width="375" /> | <img src="https://raw.githubusercontent.com/Skyscanner/backpack-react-native/main/screenshots/bpk-component-text/android/default_dm.png" alt="bpk-component-text default Google Pixel emulator - dark mode" width="375" /> |

## Emphasize

| Day | Night |
| --- | --- |
| <img src="https://raw.githubusercontent.com/Skyscanner/backpack-react-native/main/screenshots/bpk-component-text/ios/emphasize.png" alt="bpk-component-text emphasize iPhone 8 simulator" width="375" /> | <img src="https://raw.githubusercontent.com/Skyscanner/backpack-react-native/main/screenshots/bpk-component-text/ios/emphasize_dm.png" alt="bpk-component-text emphasize iPhone 8 simulator - dark mode" width="375" /> |
| <img src="https://raw.githubusercontent.com/Skyscanner/backpack-react-native/main/screenshots/bpk-component-text/android/emphasize.png" alt="bpk-component-text emphasize Google Pixel emulator" width="375" /> | <img src="https://raw.githubusercontent.com/Skyscanner/backpack-react-native/main/screenshots/bpk-component-text/android/emphasize_dm.png" alt="bpk-component-text emphasize Google Pixel emulator - dark mode" width="375" /> |

## Heavy

| Day | Night |
| --- | --- |
| <img src="https://raw.githubusercontent.com/Skyscanner/backpack-react-native/main/screenshots/bpk-component-text/ios/heavy.png" alt="bpk-component-text heavy iPhone 8 simulator" width="375" /> | <img src="https://raw.githubusercontent.com/Skyscanner/backpack-react-native/main/screenshots/bpk-component-text/ios/heavy_dm.png" alt="bpk-component-text heavy iPhone 8 simulator - dark mode" width="375" /> |
| <img src="https://raw.githubusercontent.com/Skyscanner/backpack-react-native/main/screenshots/bpk-component-text/android/heavy.png" alt="bpk-component-text heavy Google Pixel emulator" width="375" /> | <img src="https://raw.githubusercontent.com/Skyscanner/backpack-react-native/main/screenshots/bpk-component-text/android/heavy_dm.png" alt="bpk-component-text heavy Google Pixel emulator - dark mode" width="375" /> |

## Installation

Check the main [Readme](https://github.com/skyscanner/backpack-react-native#usage) for a complete installation guide.

## Usage

> Note: If rendering emoji, please wrap them in `BpkEmoji` as this will preserve the correct line height when using a custom font.

```js
import React, { Component } from 'react';
import { View, StyleSheet } from 'react-native';
import BpkText, {
  BpkEmoji,
  WEIGHT_STYLES,
} from 'backpack-react-native/bpk-component-text';
import { spacingBase } from '@skyscanner/bpk-foundations-react-native/tokens/base.react.native';

const styles = StyleSheet.create({
  container: {
    flex: 1,
    justifyContent: 'center',
    padding: spacingBase,
  }
});

export default class App extends Component {
  render() {
    return (
      <View style={styles.container}>
        <BpkText textStyle='xxl'>Backpack rocks!</BpkText>
        <BpkText textStyle='xl' weight={WEIGHT_STYLES.heavy}>Backpack rocks!</BpkText>
        <BpkText textStyle='lg' weight={WEIGHT_STYLES.emphasized}>Backpack rocks!</BpkText>
        <BpkText textStyle='base'>Backpack rocks!</BpkText>
        <BpkText textStyle='sm'>Backpack rocks!</BpkText>
        <BpkText textStyle='xs'>Backpack rocks!</BpkText>
        <BpkText textStyle='caps'>BACKPACK ROCKS!</BpkText>
        <BpkText textStyle="caps">BACKPACK ROCKS! <BpkEmoji>🎉</BpkEmoji></BpkText>
        <BpkText textStyle='lg'>
          <BpkText textStyle='inherit' weight='emphasized'>Backpack</BpkText> rocks!
        </BpkText>
      </View>
    );
  }
}
```

## Props

| Property                             | PropType                                                        | Required | Default Value |
| ------------------------------------ | --------------------------------------------------------------- | -------- | ------------- |
| children                             | node                                                            | true     | -             |
| textStyle                            | oneOf('xxl', 'xl', 'lg', 'base', 'sm', 'xs', 'caps', 'inherit')   | false    | base          |
| weight                               | oneOf('regular', 'emphasized', 'heavy')                         | false    | regular       |
| emphasize (deprecated, use `weight`) | bool                                                            | false    | false         |

## Theme props

* `textFontFamily`

NOTE: For Android we expect font names to follow a specific name convention for bold and heavy variations. E.g. if you provide a font called `myFont` to the `textFontFamily`theme attribute, we expect two more fonts to be available, those are `myFont_bold` and `myFont_black`.