npm package: @lightspeed/cirrus-wordmark
Description: Lightspeed branding component
Author: Lightspeed
Latest version: 1.0.4

# Wordmark component

A package containing a the Wordmark component, which is used for product branding.

Included within the package is also a script to generate a static version of the wordmark if needed.

## Installation

First, make sure you have been through the [install steps](https://github.com/lightspeed/flame#installing) steps required to add Flame in your application. Although it's not required to have Flame installed to use Logo, you will need to install its peer dependencies.

If using [Yarn](https://yarnpkg.com/):

```sh
yarn add @lightspeed/cirrus-wordmark
```

Or using [npm](https://www.npmjs.com/):

```sh
npm i -S @lightspeed/cirrus-wordmark
```

Next, load the required fonts. Augment the Flame [link tag](https://github.com/lightspeed/flame#link-fonts) in your `<head>` to load the required font (Assistant):

```html
<link
  href="https://fonts.googleapis.com/css?family=Lato:400,700|Assistant:600&subset=latin-ext"
  rel="stylesheet"
/>
```

## Generating a static Wordmark

You may use the `yarn render` to create all the possible variations of a Wordmark as a png format.

```
yarn render [...PRODUCT NAMES]
```

For example, running the following script:

```
yarn render eCom Restaurant "Retail POS"
```

Will render several wordmark logos for each provided product name. The output will be stored in the `render` folder.

## Usage

### Components

#### `<Wordmark />`

| Prop    | Type                         | Description                                                                                                                                                                                                                                         |
| ------- | ---------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| color   | `"dark" or "light"`          | The color scheme of the logo. Dark (the default option) will set the color of the logo and branding to something appropriate for bright backgrounds. Light will set the color of the logo and branding to something appropriate for dim backgrounds |
| type    | `"horizontal" or "vertical"` | The orientation location of the branding. Horizontal (the default option) will set the branding location to the right of the logo. Vertical will set the branding location underneat the Lightpseed logo                                            |
| size    | `"small" or "large"`         | The size of the wordmark. `small` by default.                                                                                                                                                                                                       |
| product | `string`                     | The name of the product to be rendered                                                                                                                                                                                                              |