Skip to content

Commit 5fe6328

Browse files
Docs/update links (#1084)
#### What problem is this solving? Update docs links. #### How to test it? <!--- Don't forget to add a link to a Workspace where this branch is linked --> [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)
1 parent 52e7155 commit 5fe6328

File tree

6 files changed

+16
-12
lines changed

6 files changed

+16
-12
lines changed

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
77

88
## [Unreleased]
99

10+
### Fixed
11+
- Update readme links.
12+
1013
## [3.167.0] - 2023-03-28
1114

1215
### Added

docs/Image.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ The `image` block renders images in the storefront.
5151

5252
## Customization
5353

54-
To apply CSS customizations in this and other blocks, follow the [Using CSS handles for store customization](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-using-css-handles-for-store-customization) guide.
54+
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.
5555

5656
| CSS Handles |
5757
| --- |

docs/InfoCard.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ The `info-card` component groups information related to a single topic. They oft
66

77
![image](https://user-images.githubusercontent.com/284515/70229574-4239a100-1735-11ea-9e30-00b286e03f7c.png)
88

9+
910
## Configuration
1011

1112
1. Import the `vtex.store-components` app to your theme's dependencies in the `manifest.json` file, as in the following example:
@@ -92,7 +93,7 @@ These values are the same ones supported by HTML5 anchor tags. For more informat
9293

9394
## Customization
9495

95-
To apply CSS customizations in this and other blocks, follow the [Using CSS handles for store customization](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-using-css-handles-for-store-customization) guide.
96+
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.
9697

9798
| CSS Handles |
9899
| ---------- |

docs/ProductImages.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,9 @@ The `product-images` block is responsible for rendering a product image or video
5050
| `contentType` | `enum` | Controls the type of content that will be displayed in the block. Possible values are: `images`, `videos`, or `all`. | `all` |
5151
| `displayMode` | `enum` | Defines how the product media should be displayed. Possible values are `carousel` (displays the product images and videos in a carousel), `list` (displays only the product images inline, with no extra markup) and `first-image` (displays only the first image available). *Caution*: The `list` and `first-image` values do not display product videos and are only compatible with the `maxHeight`, `hiddenImages`, `zoomFactor`, `aspectRatio`,`ModalZoomElement`, and `zoomMode` props. | `carousel` |
5252
| `displayThumbnailsArrows` | `boolean` | Displays navigation arrows on the thumbnails media (if there are enough thumbnails for them to scroll) | `false` |
53-
| `hiddenImages` | `string` | Hides images whose labels match the values listed in this prop. Intended to be used along with the `product-summary-sku-selector` block. You can have more information at the [SKU Selector](https://developers.vtex.com/vtex-developer-docs/docs/vtex-store-components-skuselector) documentation | `skuvariation` |
53+
| `hiddenImages` | `string` | Hides images whose labels match the values listed in this prop. Intended to be used along with the `product-summary-sku-selector` block. You can have more information at the [SKU Selector](https://developers.vtex.com/docs/apps/vtex.store-components/skuselector) documentation | `skuvariation` |
5454
| `maxHeight` | `number` | Maximum height for individual product images (in pixels). | `600` |
55-
| `ModalZoom` | `block` | Opens a modal for product image zooming. This prop's value must match the name of the block responsible for triggering the modal containing the product image for zooming (e.g. `modal-layout` from [Modal layout](https://developers.vtex.com/vtex-developer-docs/docs/vtex-modal-layout) app). Notice that the `ModalZoom` prop will work only if the `zoomMode` prop is set as `open-modal`. To learn more, check out the [Advanced Configuration section](#Advanced-Configuration). | `undefined` |
55+
| `ModalZoom` | `block` | Opens a modal for product image zooming. This prop's value must match the name of the block responsible for triggering the modal containing the product image for zooming (e.g. `modal-layout` from [Modal layout](https://developers.vtex.com/docs/apps/vtex.modal-layout) app). Notice that the `ModalZoom` prop will work only if the `zoomMode` prop is set as `open-modal`. To learn more, check out the [Advanced Configuration section](#Advanced-Configuration). | `undefined` |
5656
| `placeholder` | `string` | Sets the URL for a placeholder image to be used in case there is no available image or video of the product. | `undefined` |
5757
| `position` | `Enum` | Set the position of the thumbnails (`left` or `right`). Only used when `thumbnailsOrientation` is `vertical` | `left` |
5858
| `showNavigationArrows` | `boolean` | Controls if the navigation arrows should appear | `true` |
@@ -106,7 +106,7 @@ Check out the following example:
106106
}
107107
```
108108

109-
Notice that the `product-images.high-quality-image` block must be declared as a child of `modal-layout` and, in addition to that, you can also declare other blocks exported by the [Modal Layout app](https://developers.vtex.com/vtex-developer-docs/docs/vtex-modal-layout) as children.
109+
Notice that the `product-images.high-quality-image` block must be declared as a child of `modal-layout` and, in addition to that, you can also declare other blocks exported by the [Modal Layout app](https://developers.vtex.com/docs/apps/vtex.modal-layout) as children.
110110

111111
The following table shows the props allowed by `product-images.high-quality-image`:
112112

@@ -121,7 +121,7 @@ The following table shows the props allowed by `product-images.high-quality-imag
121121

122122
## Customization
123123

124-
To apply CSS customizations in this and other blocks, follow the [Using CSS handles for store customization](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-using-css-handles-for-store-customization) guide.
124+
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.
125125

126126
| CSS Handles |
127127
| --- |

docs/SKUSelector.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ The `sku-selector` block is mainly used in Product Details Pages (PDPs) to displ
6060
| `sliderItemsPerPage` | `object` | Controls how many slides should be shown on each type of device when `displayMode` is set as `slider`. Check out more information regarding this prop structure below this table. | `{desktop: 3, tablet: 2, phone: 1}` |
6161
| `showVariationsErrorMessage` | `boolean` | Whether an error message should be displayed whenever the `BuyButton` is clicked on but no available variation was selected (`true`) or not (`false`). | `true` |
6262
| `showVariationsLabels` | `enum` | Where variation names should be displayed. Possible values are: `none` (doesn't display the variation names. Replaces the previous `false` behavior), `variation` (shows the variation name as a header of the items. Replaces the previous `true` behavior), `itemValue` (displays the variation name before with each item's value) and `variationAndItemValue` (behaves as `variation` and `itemValue` at the same time). | `variation` |
63-
| `thumbnailImage` | `string` | First image to be displayed. This prop value must be the same text string defined in the desired product image's `imageLabel` field (from the Catalog module). If you use this prop and no image declaring the same text string in its `imageLabel` field is found, any product image will be randomly rendered instead. To apply the `thumbnailImage` configuration, see the [Configuring custom images for the SKU Selector documentation](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-configuring-custom-images-for-the-sku-selector) | `undefined` |
63+
| `thumbnailImage` | `string` | First image to be displayed. This prop value must be the same text string defined in the desired product image's `imageLabel` field (from the Catalog module). If you use this prop and no image declaring the same text string in its `imageLabel` field is found, any product image will be randomly rendered instead. To apply the `thumbnailImage` configuration, see the [Configuring custom images for the SKU Selector documentation](https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-custom-images-for-the-sku-selector) | `undefined` |
6464
| `variationsSpacing` | `number` | Defines the `margin-bottom` size to be applied in the rendered product variations. Possible values are from `0` to `11` (the prop value is not in `px`, every value represents a tachyons class). | `7` |
6565
| `visibility` | `enum` | Defines the scenarios in which the SKU selector should be displayed. Possible values are: `always` (it will always be displayed even if the product has only one SKU option) or `more-than-one` (the SKU Selector is only displayed when the product has more than one SKU option). | `always` |
6666
| `visibleVariations` | `array` | Specifies which product variations should be displayed in the product details page. Notice the following: if you declare a name that doesn't represent a real product variation or an empty array, no variations will be displayed. Check out more information regarding this prop structure below this table. | `undefined` |
@@ -81,7 +81,7 @@ The `sku-selector` block is mainly used in Product Details Pages (PDPs) to displ
8181

8282
## Customization
8383

84-
To apply CSS customizations in this and other blocks, follow the [Using CSS handles for store customization](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-using-css-handles-for-store-customization) guide.
84+
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.
8585

8686
| CSS Handles |
8787
| ------------------------------- |

docs/SearchBar.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The `search-bar` component shows a search bar with autocomplete options and disp
1616
}
1717
```
1818

19-
2. Add the `search-bar` block into the [`header`](https://developers.vtex.com/vtex-developer-docs/docs/vtex-store-header/) component. For example:
19+
2. Add the `search-bar` block into the [`header`](https://developers.vtex.com/docs/apps/vtex.store-header) component. For example:
2020

2121
```diff
2222
"header.full": {
@@ -68,15 +68,15 @@ The `search-bar` component shows a search bar with autocomplete options and disp
6868
| `search-button` | `'search-button'` | ![search-button-empty](https://user-images.githubusercontent.com/12702016/74764929-65b6b700-5261-11ea-815c-ecc9f0c44e0f.png) | ![search-button-filled](https://user-images.githubusercontent.com/12702016/74764934-66e7e400-5261-11ea-8a86-59da9a1c0faa.png) |
6969

7070
## Using SearchBar with Intelligent Search
71-
To improve the search experience usign the SearchBar component, such as the autocomplete option, you must use the component within [Search app](https://developers.vtex.com/vtex-developer-docs/docs/vtex-search) responsible for handling the [Intelligent Search (IS)](https://help.vtex.com/tracks/vtex-intelligent-search?_ga=2.220970832.979717665.1650285782-1001456323.1619912759) solution in IO stores.
71+
To improve the search experience usign the SearchBar component, such as the autocomplete option, you must use the component within [Search app](https://developers.vtex.com/docs/apps/vtex.search) responsible for handling the [Intelligent Search (IS)](https://help.vtex.com/tracks/vtex-intelligent-search?_ga=2.220970832.979717665.1650285782-1001456323.1619912759) solution in IO stores.
7272

7373
The IS communicates with the `autocomplete-result-list.v2` block exported by the Search app, and the block displays previous search results based on current and previous searches.
7474

75-
Follow the [Search documentation](https://developers.vtex.com/vtex-developer-docs/docs/vtex-search) to add the Search app to your store.
75+
Follow the [Search documentation](https://developers.vtex.com/docs/apps/vtex.search) to add the Search app to your store.
7676

7777
## Customization
7878

79-
To apply CSS customizations in this and other blocks, follow the [Using CSS handles for store customization](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-using-css-handles-for-store-customization) guide.
79+
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.
8080

8181
| CSS Handles |
8282
| -------------------------------- |

0 commit comments

Comments
 (0)