Skip to content

Commit 09da37e

Browse files
authored
PWA docs (#283)
* PWA docs * PWA devdocs * PWA devdocs
1 parent db293b8 commit 09da37e

File tree

4 files changed

+10
-25
lines changed

4 files changed

+10
-25
lines changed

src/data/auto-generated/magento-compatibility.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
21
| PWA Studio version | Magento core version|
32
| :---: | :---: |
3+
| 14.2.0 | 2.4.7-p4 |
44
| 14.1.0 | 2.4.7-p2 |
55
| 14.0.1 | 2.4.7-beta3 |
66
| 14.0.0 | 2.4.7-beta3 |

src/data/auto-generated/peregrine/lib/talons/CartPage/PriceAdjustments/CouponCode/useCouponCode.md

+7-12
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,6 @@ This talon performs the following effects:
141141
- Manage the updating state of the cart while a coupon is being applied or removed
142142

143143
**Returns:**
144-
145144
**Parameters**
146145

147146
| Name | Type | Description |
@@ -151,7 +150,7 @@ This talon performs the following effects:
151150
| props.mutations | [`CouponCodeMutations`](#CouponCodeMutations) | GraphQL mutations for a cart's coupon code. |
152151
| props.queries | [`CouponCodeQueries`](#CouponCodeQueries) | GraphQL queries for a cart's coupon code. |
153152

154-
**Example** *(Importing into your project)*
153+
**Example** *(Importing into your project)*
155154

156155
```js
157156
import { useCouponCode } from '@magento/peregrine/lib/talons/CartPage/PriceAdjustments/CouponCode/useCouponCode';
@@ -165,7 +164,6 @@ This talon performs the following effects:
165164
- Manage the updating state of the cart while the mutation for setting the shipping address is in flight
166165

167166
**Returns:**
168-
169167
**Parameters**
170168

171169
| Name | Type | Description |
@@ -176,7 +174,7 @@ This talon performs the following effects:
176174
| props.mutations | [`ShippingFormMutations`](#ShippingFormMutations) | GraphQL mutations for the shipping form. |
177175
| props.queries | [`ShippingFormQueries`](#ShippingFormQueries) | GraphQL queries for the shipping form. |
178176

179-
**Example** *(Importing into your project)*
177+
**Example** *(Importing into your project)*
180178

181179
```js
182180
import { useShippingForm } from '@magento/peregrine/lib/talons/CartPage/PriceAdjustments/ShippingMethods/useShippingForm';
@@ -190,18 +188,16 @@ This talon performs the following effects:
190188
- Set the shipping form visibility value based on the shipping methods associated with the cart
191189

192190
**Returns:**
193-
194191
**Parameters**
195192

196193
| Name | Type | Description |
197194
| --- | --- | --- |
198195
| props | `Object` | |
199196
| props.queries | [`ShippingMethodsQueries`](#ShippingMethodsQueries) | GraphQL queries for shipping methods |
200197

201-
**Example** *(Importing into your project)*
198+
**Example** *(Importing into your project)*
202199

203200
```js
204-
205201
import { useShippingMethods } from '@magento/peregrine/lib/talons/CartPage/PriceAdjustments/ShippingMethods/useShippingMethods';
206202
```
207203

@@ -214,7 +210,6 @@ This talon performs the following effects:
214210
- Manage the updating state of the cart while a shipping method is being applied
215211

216212
**Returns:**
217-
218213
**Parameters**
219214

220215
| Name | Type | Description |
@@ -296,8 +291,8 @@ for the query used in Venia
296291
GraphQL queries for the shipping form.
297292
This is a type used by the [useShippingForm](#useShippingForm) talon.
298293

299-
**See**: [shippingMethods.gql.js](https://github.com/magento/pwa-studio/blob/develop/packages/venia-ui/lib/components/CartPage/PriceAdjustments/ShippingMethods/shippingMethods.gql.js) for the query used in Venia
300-
294+
**See**: [shippingMethods.gql.js](https://github.com/magento/pwa-studio/blob/develop/packages/venia-ui/lib/components/CartPage/PriceAdjustments/ShippingMethods/shippingMethods.gql.js)
295+
for the query used in Venia
301296
**Properties**
302297

303298
| Name | Type | Description |
@@ -320,8 +315,8 @@ It provides props data to use when rendering a shipping form component.
320315
GraphQL queries for shipping methods.
321316
This is a type used in the [useShippingMethods](#useShippingMethods) talon.
322317

323-
**See**: [shippingMethods.gql.js](https://github.com/magento/pwa-studio/blob/develop/packages/venia-ui/lib/components/CartPage/PriceAdjustments/ShippingMethods/shippingMethods.gql.js) for the queries used in Venia
324-
318+
**See**: [shippingMethods.gql.js](https://github.com/magento/pwa-studio/blob/develop/packages/venia-ui/lib/components/CartPage/PriceAdjustments/ShippingMethods/shippingMethods.gql.js)
319+
for the queries used in Venia
325320
**Properties**
326321

327322
| Name | Type | Description |

src/data/auto-generated/peregrine/lib/talons/CartPage/PriceSummary/usePriceSummary.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -46,18 +46,16 @@ This talon performs the following effects:
4646
- Log a GraphQL error if it occurs when getting the price summary
4747

4848
**Returns:**
49-
5049
**Parameters**
5150

5251
| Name | Type | Description |
5352
| --- | --- | --- |
5453
| props | `Object` | |
5554
| props.queries | [`PriceSummaryQueries`](#PriceSummaryQueries) | GraphQL queries for a price summary component. |
5655

57-
**Example** *(Importing into your project)*
56+
**Example** *(Importing into your project)*
5857

5958
```js
60-
6159
import { usePriceSummary } from '@magento/peregrine/lib/talons/CartPage/PriceSummary/usePriceSummary';
6260
```
6361

src/data/auto-generated/peregrine/lib/talons/CartPage/ProductListing/useProductListing.md

+1-9
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,6 @@ This talon performs the following effects:
116116
- Log any GraphQL errors to the console
117117

118118
**Returns:**
119-
120119
**Parameters**
121120

122121
| Name | Type | Description |
@@ -127,7 +126,6 @@ This talon performs the following effects:
127126
**Example** *(Importing into your project)*
128127

129128
```js
130-
131129
import { useProductListing } from '@magento/peregrine/lib/talons/CartPage/ProductListing/useProductListing';
132130
```
133131

@@ -139,7 +137,6 @@ This talon performs the following effects:
139137
- Manage the updating state of the cart while a product is being updated or removed
140138

141139
**Returns:**
142-
143140
**Parameters**
144141

145142
| Name | Type | Description |
@@ -153,19 +150,16 @@ This talon performs the following effects:
153150
**Example** *(Importing into your project)*
154151

155152
```js
156-
157153
import { useProduct } from '@magento/peregrine/lib/talons/CartPage/ProductListing/useProduct';
158154
```
159155

160156
This talon contains logic for a product edit modal used on a cart page.
161157
It returns prop data for rendering an interactive modal component.
162158

163159
**Returns:**
164-
165160
**Example** *(Importing into your project)*
166161

167162
```js
168-
169163
import { useEditModal } from '@magento/peregrine/lib/talons/CartPage/ProductListing/EditModal/useEditModal';
170164
```
171165

@@ -178,7 +172,6 @@ This talon performs the following effects:
178172
- Set the variant price on a product depending on the product's options
179173

180174
**Returns:**
181-
182175
**Parameters**
183176

184177
| Name | Type | Description |
@@ -195,7 +188,6 @@ This talon performs the following effects:
195188
**Example** *(Importing into your project)*
196189

197190
```js
198-
199191
import { useProductForm } from '@magento/peregrine/lib/talons/CartPage/ProductListing/EditModal/useProductForm';
200192
```
201193

@@ -287,7 +279,7 @@ It provides props data for rendering an edit modal component.
287279
| Name | Type | Description |
288280
| --- | --- | --- |
289281
| setVariantPrice | `function` | Function for setting a product's variant price. |
290-
| variantPrice | `Object` | The variant price for a product. See [Money object](https://developer.adobe.com/commerce/webapi/graphql/product/product-interface.html#Money). |
282+
| variantPrice | `Object` | The variant price for a product. See [Money object](https://devdocs.magento.com/guides/v2.4/graphql/product/product-interface.html#Money). |
291283

292284
Object type returned by the [useProductForm](useProductForm) talon.
293285
It provides props data for a product form UI component inside a modal.

0 commit comments

Comments
 (0)