Skip to content

Commit

Permalink
Merge pull request #1067 from vtex-apps/docs/update-props-name
Browse files Browse the repository at this point in the history
Update ProductName.md
  • Loading branch information
carolinamenezes authored Nov 22, 2022
2 parents 7aa0ea9 + 6d4ee8f commit 690b11d
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 8 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## [Unreleased]
### Fixed
- Update Product Name doc.

## [3.163.3] - 2022-11-17

Expand Down
17 changes: 9 additions & 8 deletions docs/ProductName.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@
# Product Name

The `product-name` block is responsible for displaying a product name along with other information about the product, such as **SKU** or **brand**.
The `product-name` block is responsible for displaying a product name along with other information about the product, such as the **SKU** or **brand**.

![image](https://user-images.githubusercontent.com/284515/70231165-8f6b4200-1738-11ea-9f06-3583c08fc693.png)

## Configuration

1. Import the `vtex.store-components` app to your theme's dependencies in the `manifest.json` file as in the following example:
1. Import the `vtex.store-components` app to your theme's dependencies in the `manifest.json` file, as in the following example:

```json
"dependencies: {
"dependencies": {
"vtex.store-components": "3.x"
}
```
Expand Down Expand Up @@ -46,11 +46,12 @@ The `product-name` block is responsible for displaying a product name along with

| Prop name | Type | Description | Default value |
| --- | --- | --- | ---|
| `classes` | `CustomCSSClasses` | Overrides default CSS handles. To better understand how this prop works, check [this document](https://github.com/vtex-apps/css-handles#usecustomclasses). Note that this is only helpful if you're using this block as a React component. | `undefined` |
| `displayMode` | `enum` | Possible values are: `linkToProductPage` (show the product link associated with its name) or `plainText` (to show only the product name). | `plainText`|
| `showBrandName` | `Boolean` | Brand name. | `false`|
| `showProductReference` | `Boolean` | Product reference code. | `false`|
| `showSku` | `Boolean` | Product SKU. | `false` |
| `classes` | `CustomCSSClasses` | Overrides default CSS handles. For further information, please refer to [this document](https://github.com/vtex-apps/css-handles#usecustomclasses). Note that this is only helpful if you're using this block as a React component. | `undefined` |
| `displayMode` | `enum` | Displays the product name (`plainText`) or the link to the product page (`linkToProductPage`). | `plainText`|
| `showBrandName` | `boolean` | Displays the brand name. | `false`|
| `showProductReference` | `boolean` | Displays the product reference code. | `false`|
| `showSku` | `boolean` | Displays the SKU value. | `false` |
| `tag` | `string` | Defines the HTML tag of the product container. Possible values are: `div`, `h1`, `h2`, `h3`. | `div` |

## Customization

Expand Down

0 comments on commit 690b11d

Please sign in to comment.