Skip to content

Commit

Permalink
fixes of i18n on image.md (#1085)
Browse files Browse the repository at this point in the history 
#### What problem is this solving?

Updating the image.md file according to i18n fixes requested on task
https://vtex-dev.atlassian.net/browse/LOC-10534

#### How to test it?

With any text editor that supports .md files.

[Workspace](Link goes here!)

#### Screenshots or example usage:

<!--- Add some images or gifs to showcase changes in behaviour or
layout. Example: before and after images -->

#### Describe alternatives you've considered, if any.

<!--- Optional -->

#### Related to / Depends on

<!--- Optional -->

#### How does this PR make you feel? [:link:](http://giphy.com/)

<!-- Go to http://giphy.com/ and pick a gif that represents how this PR
makes you feel -->

![](put .gif link here - can be found under "advanced" on giphy)
  • Loading branch information
@GeorgeLimaDev
GeorgeLimaDev authored Apr 20, 2023
1 parent 7cbbd77 commit 87f8458
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 22 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
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
- Updated readme.md according to task LOC-10534.

## [3.167.1] - 2023-04-17

Expand Down
44 changes: 22 additions & 22 deletions docs/Image.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,21 @@
# Image

The `image` block renders images in the storefront.
The `image` block renders images in the storefront.

<img src="https://user-images.githubusercontent.com/60782333/197802548-bc9940ae-b9c8-47df-9769-e76155b9219b.png" width="400" />

## 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 dependencies in the `manifest.json` file as in the following example:

```json
"dependencies": {
"vtex.store-components": "3.x"
}
```

2. Add the `image` block to any template of your choice.
2. Add the `image` block to any template you choose.
3. Then, declare the `image` block using the props stated in the [Props](#props) table. For example:

```json
Expand All @@ -30,29 +30,29 @@ The `image` block renders images in the storefront.

### Props

| Prop name | Type | Description | Default value |
| ------------- | ---------- | -------------------------------------------------------------------------- | - |
| `alt` | `string` | Alternate text for the image. | - |
| `link` | [`Link`](https://github.com/vtex-apps/native-types/blob/f63aeeb8f6e62f4a9aaec052a8be34973be7389b/pages/contentSchemas.json#L52-L71)| The image hyperlink. For more details on the props of the `link`, please refer to the following table. | - |
| `maxHeight` | `string` | Max height of the image. | - |
| `maxWidth` | `string` | Max width of the image. | - |
| `sizes` | `string` | Different image sizes for each page layout. | - |
| `src` | `string!` | Source URL of the image. | - |
| `srcSet` | `string` | URL of the image to use in different situations. | - |
| `title` | `string` | Image title displayed on hover | - |
| Prop name | Type | Description | Default value |
| ----------- | ----------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------- |
| `alt` | `string` | Alternate text for the image. | - |
| `link` | [`Link`](https://github.com/vtex-apps/native-types/blob/f63aeeb8f6e62f4a9aaec052a8be34973be7389b/pages/contentSchemas.json#L52-L71) | The image hyperlink. For more details on the props of the `link`, please see the following table. | - |
| `maxHeight` | `string` | Maximum height of the image. | - |
| `maxWidth` | `string` | Maximum width of the image. | - |
| `sizes` | `string` | Different image sizes for each page layout. | - |
| `src` | `string` | Source URL of the image. | - |
| `srcSet` | `string` | URL of the image to use in different situations. | - |
| `title` | `string` | Image title displayed on hover. | - |

- **`link` props:**

| Prop name | Type | Description | Default value |
| ------------- | ---------- | -------------------------------------------------------------------------- | - |
| `attributeNofollow`| `boolean` | Guides the search engine not to track the link of the page indicated by the tag. If `true` sets `rel=noFollow` attribute to the link. |`false` |
| `newTab`| `boolean`| If `true` opens a new tab when you click on the image. | `false` |
| `url`| `string` | Sets the URL to which the user will be redirected by clicking on the image. | - |
| Prop name | Type | Description | Default value |
| ------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------- |
| `attributeNofollow` | `boolean` | Guides the search engine not to track the link of the page indicated by the tag. If `true`, sets the `rel=noFollow` attribute to the link. | `false` |
| `newTab` | `boolean` | If `true` opens a new tab when you click the image. | `false` |
| `url` | `string` | Sets the URL to which the user will be redirected by clicking the image. | - |

## Customization

To apply CSS customizations in this and other blocks, follow the [Using CSS handles for store customization](https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization) guide.
To apply CSS customizations to this and other blocks, please read the [Using CSS handles for store customization](https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization) guide.

| CSS Handles |
| --- |
| `imageElement` |
| CSS Handles |
| -------------- |
| `imageElement` |

0 comments on commit 87f8458

Please sign in to comment.