@iress-oss/ids-mcp-server 6.0.0-alpha.1-canary-20251204032753-fe18cab → 6.0.0-alpha.1-canary-20251204040305-3639454

package/generated/docs/components_components-image-docs.md

@@ -0,0 +1,168 @@
+Image
+=====
+
+Overview
+--------
+
+`IressImage` renders an image that resizes based on the user's screen width. The component accepts standard image attributes like \`src\` and \`alt\`.
+
+* * *
+
+Beta
+
+**New component**
+
+This component is new, please provide feedback to the Frontend Enablement team if you encounter any issues.
+
+[](./iframe.html?id=components-image--default)
+
+![Placeholder image](https://www.fdcbuilding.com.au/wp-content/webp-express/webp-images/uploads/2020/01/4-1.jpg.webp)
+
+```
+
+<IressImage
+  alt\="Placeholder image"
+  src\="https://www.fdcbuilding.com.au/wp-content/webp-express/webp-images/uploads/2020/01/4-1.jpg.webp"
+/>
+
+```
+
+Props
+-----
+
+| Name | Description | Default | Control |
+| --- | --- | --- | --- |
+| alt\* | 
+The alternative text representation of the image. It is used by screen readers to describe the image. If the image is intended for decoration purposes only, make it an empty string.
+
+string
+
+
+
+ | \- | Placeholder image |
+| maxWidth | 
+
+Override the maximum width of the image
+
+union
+
+
+
+ | 
+
+'100%'
+
+ | Set object |
+| src\* | 
+
+The address of the image
+
+string
+
+
+
+ | \- | https://www.fdcbuilding.com.au/wp-content/webp-express/webp-images/uploads/2020/01/4-1.jpg.webp |
+
+Examples
+--------
+
+### MaxWidth
+
+`maxWidth` accepts formats like `70 (numbers)` `250px (pixels)` `50% (percentages)` `undefined (fall back to default 100%)`, allowing you to display the image smaller than its original size, yet still responsive on smaller screen sizes.
+
+**Note:** Please consider not using this prop, but rather exporting images at the largest size required for your application (the maximum width).
+
+[](./iframe.html?id=components-image--max-width)
+
+### 70
+
+![Placeholder image](https://www.fdcbuilding.com.au/wp-content/webp-express/webp-images/uploads/2020/01/4-1.jpg.webp)
+
+### 250px
+
+![Placeholder image](https://www.fdcbuilding.com.au/wp-content/webp-express/webp-images/uploads/2020/01/4-1.jpg.webp)
+
+### 50%
+
+![Placeholder image](https://www.fdcbuilding.com.au/wp-content/webp-express/webp-images/uploads/2020/01/4-1.jpg.webp)
+
+### undefined
+
+![Placeholder image](https://www.fdcbuilding.com.au/wp-content/webp-express/webp-images/uploads/2020/01/4-1.jpg.webp)
+
+```
+
+<IressStack gap\="md"\>
+  <React.Fragment key\=".$0"\>
+    <IressText element\="h3"\>
+      70    </IressText\>
+    <IressImage
+      alt\="Placeholder image"
+      maxWidth\={70}
+      src\="https://www.fdcbuilding.com.au/wp-content/webp-express/webp-images/uploads/2020/01/4-1.jpg.webp"
+    />
+  </React.Fragment\>
+  <React.Fragment key\=".$1"\>
+    <IressText element\="h3"\>
+      250px    </IressText\>
+    <IressImage
+      alt\="Placeholder image"
+      maxWidth\="250px"
+      src\="https://www.fdcbuilding.com.au/wp-content/webp-express/webp-images/uploads/2020/01/4-1.jpg.webp"
+    />
+  </React.Fragment\>
+  <React.Fragment key\=".$2"\>
+    <IressText element\="h3"\>
+      50%    </IressText\>
+    <IressImage
+      alt\="Placeholder image"
+      maxWidth\="50%"
+      src\="https://www.fdcbuilding.com.au/wp-content/webp-express/webp-images/uploads/2020/01/4-1.jpg.webp"
+    />
+  </React.Fragment\>
+  <React.Fragment key\=".$3"\>
+    <IressText element\="h3"\>
+      undefined    </IressText\>
+    <IressImage
+      alt\="Placeholder image"
+      src\="https://www.fdcbuilding.com.au/wp-content/webp-express/webp-images/uploads/2020/01/4-1.jpg.webp"
+    />
+  </React.Fragment\>
+</IressStack\>
+
+```
+
+#### Props
+
+| Name | Description | Default | Control |
+| --- | --- | --- | --- |
+| alt\* | 
+The alternative text representation of the image. It is used by screen readers to describe the image. If the image is intended for decoration purposes only, make it an empty string.
+
+string
+
+
+
+ | \- | Placeholder image |
+| maxWidth | 
+
+Override the maximum width of the image
+
+union
+
+
+
+ | 
+
+'100%'
+
+ | Set object |
+| src\* | 
+
+The address of the image
+
+string
+
+
+
+ | \- | https://www.fdcbuilding.com.au/wp-content/webp-express/webp-images/uploads/2020/01/4-1.jpg.webp |