Skip to content

Commit 8efba47

Browse files
fix descriptions
1 parent f298402 commit 8efba47

File tree

5 files changed

+4964
-27
lines changed

5 files changed

+4964
-27
lines changed

packages/hydrogen-react/src/MediaFile.tsx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ type MediaOptions = {
3535
* The `MediaFile` component renders the media for the Storefront API's
3636
* [Media object](https://shopify.dev/api/storefront/reference/products/media). It renders an `Image`, a
3737
* `Video`, an `ExternalVideo`, or a `ModelViewer` depending on the `__typename` of the `data` prop.
38+
* Use the `mediaOptions` prop to customize the props sent to each of these components.
3839
* @publicDocs
3940
*/
4041
export function MediaFile({

packages/hydrogen-react/src/RichText.tsx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -209,5 +209,9 @@ function richTextToString(
209209
}
210210

211211
// This is only for documentation purposes, and it is not used in the code.
212+
/**
213+
* The `RichText` component renders a metafield of type `rich_text_field`. By default the rendered output uses semantic HTML tags. Customize how nodes are rendered with the `components` prop.
214+
* @publicDocs
215+
*/
212216
export type RichTextPropsForDocs<AsType extends React.ElementType = 'div'> =
213217
RichTextPropsBase<AsType>;

packages/hydrogen-react/src/optionValueDecoder.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ const V1_CONTROL_CHARS = {
2020
RANGE: '-',
2121
};
2222

23+
/** @publicDocs */
2324
export type IsOptionValueCombinationInEncodedVariant = (
2425
targetOptionValueCombination: number[],
2526
encodedVariantField: string,

packages/hydrogen/docs/build-docs.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
COMPILE_DOCS="generate-docs --overridePath ./docs/typeOverride.json --input ./src --output ./docs/generated"
1+
COMPILE_DOCS="generate-docs --overridePath ./docs/typeOverride.json --input ./src ../hydrogen-react/src --output ./docs/generated"
22

33
if [ "$1" = "isTest" ];
44
then
5-
COMPILE_DOCS="generate-docs --overridePath ./docs/typeOverride.json --input ./src --output ./docs/temp"
5+
COMPILE_DOCS="generate-docs --overridePath ./docs/typeOverride.json --input ./src ../hydrogen-react/src --output ./docs/temp"
66
fi
77

88
eval $COMPILE_DOCS

0 commit comments

Comments
 (0)