@siemens/ix-docs 4.0.0 → 4.2.0

package/build/component-usage-by-component.json

@@ -52,29 +52,8 @@
     "/src/preview-examples/input-with-slots.html",
     "/src/preview-examples/number-input-with-slots.html",
     "/src/preview-examples/tabs-rounded.html",
-    "/src/preview-examples/time-input-with-slots.html"
-  ],
-  "ix-dropdown-button": [
-    "/src/preview-examples/application-app-switch.html",
-    "/src/preview-examples/application-breakpoints.html",
-    "/src/preview-examples/application-header.html",
-    "/src/preview-examples/dropdown-button-icon.html",
-    "/src/preview-examples/dropdown-button.html"
-  ],
-  "ix-dropdown-item": [
-    "/src/preview-examples/application-app-switch.html",
-    "/src/preview-examples/application-breakpoints.html",
-    "/src/preview-examples/application-header.html",
-    "/src/preview-examples/blind-header-actions.html",
-    "/src/preview-examples/dropdown-button-icon.html",
-    "/src/preview-examples/dropdown-button.html",
-    "/src/preview-examples/dropdown-icon.html",
-    "/src/preview-examples/dropdown-quick-actions.html",
-    "/src/preview-examples/dropdown-submenu.html",
-    "/src/preview-examples/dropdown.html",
-    "/src/preview-examples/group-context-menu.html",
-    "/src/preview-examples/split-button-icons.html",
-    "/src/preview-examples/split-button.html"
+    "/src/preview-examples/time-input-with-slots.html",
+    "/src/preview-examples/tooltip-with-icon.html"
   ],
   "ix-avatar": [
     "/src/preview-examples/application-advanced.html",
@@ -95,6 +74,14 @@
     "/src/preview-examples/vertical-tabs-with-avatar.html",
     "/src/preview-examples/vertical-tabs.html"
   ],
+  "ix-menu-category": [
+    "/src/preview-examples/application-advanced.html",
+    "/src/preview-examples/menu-category.html"
+  ],
+  "ix-menu-settings": [
+    "/src/preview-examples/application-advanced.html",
+    "/src/preview-examples/settings.html"
+  ],
   "ix-content": [
     "/src/preview-examples/application-advanced.html",
     "/src/preview-examples/application-app-switch.html",
@@ -112,13 +99,27 @@
     "/src/preview-examples/content-header.html",
     "/src/preview-examples/content.html"
   ],
-  "ix-menu-category": [
-    "/src/preview-examples/application-advanced.html",
-    "/src/preview-examples/menu-category.html"
+  "ix-dropdown-button": [
+    "/src/preview-examples/application-app-switch.html",
+    "/src/preview-examples/application-breakpoints.html",
+    "/src/preview-examples/application-header.html",
+    "/src/preview-examples/dropdown-button-icon.html",
+    "/src/preview-examples/dropdown-button.html"
   ],
-  "ix-menu-settings": [
-    "/src/preview-examples/application-advanced.html",
-    "/src/preview-examples/settings.html"
+  "ix-dropdown-item": [
+    "/src/preview-examples/application-app-switch.html",
+    "/src/preview-examples/application-breakpoints.html",
+    "/src/preview-examples/application-header.html",
+    "/src/preview-examples/blind-header-actions.html",
+    "/src/preview-examples/dropdown-button-icon.html",
+    "/src/preview-examples/dropdown-button.html",
+    "/src/preview-examples/dropdown-icon.html",
+    "/src/preview-examples/dropdown-quick-actions.html",
+    "/src/preview-examples/dropdown-submenu.html",
+    "/src/preview-examples/dropdown.html",
+    "/src/preview-examples/group-context-menu.html",
+    "/src/preview-examples/split-button-icons.html",
+    "/src/preview-examples/split-button.html"
   ],
   "ix-radio-group": [
     "/src/preview-examples/application-breakpoints.html",
@@ -200,6 +201,7 @@
     "/src/preview-examples/message-bar-removal.html",
     "/src/preview-examples/message-bar.html",
     "/src/preview-examples/message.html",
+    "/src/preview-examples/modal-close.html",
     "/src/preview-examples/modal-form-ix-button-submit.html",
     "/src/preview-examples/modal-sizes.html",
     "/src/preview-examples/modal.html",
@@ -210,6 +212,7 @@
     "/src/preview-examples/toast-custom.html",
     "/src/preview-examples/toast-position.html",
     "/src/preview-examples/toast.html",
+    "/src/preview-examples/tooltip-with-icon.html",
     "/src/preview-examples/tooltip.html",
     "/src/preview-examples/tree-custom.html",
     "/src/preview-examples/validation-select.html"
@@ -353,7 +356,8 @@
     "/src/preview-examples/form-checkbox-group-indeterminate.html",
     "/src/preview-examples/form-checkbox-group.html",
     "/src/preview-examples/form-checkbox-validation.html",
-    "/src/preview-examples/form-checkbox.html"
+    "/src/preview-examples/form-checkbox.html",
+    "/src/preview-examples/theme-switcher.html"
   ],
   "ix-checkbox-group": [
     "/src/preview-examples/form-checkbox-group-indeterminate.html",
@@ -449,14 +453,17 @@
     "/src/preview-examples/message-bar.html"
   ],
   "ix-modal-header": [
+    "/src/preview-examples/modal-close.html",
     "/src/preview-examples/modal-form-ix-button-submit.html",
     "/src/preview-examples/modal.html"
   ],
   "ix-modal-content": [
+    "/src/preview-examples/modal-close.html",
     "/src/preview-examples/modal-form-ix-button-submit.html",
     "/src/preview-examples/modal.html"
   ],
   "ix-modal-footer": [
+    "/src/preview-examples/modal-close.html",
     "/src/preview-examples/modal-form-ix-button-submit.html",
     "/src/preview-examples/modal.html"
   ],
@@ -560,6 +567,7 @@
     "/src/preview-examples/toggle.html"
   ],
   "ix-tooltip": [
+    "/src/preview-examples/tooltip-with-icon.html",
     "/src/preview-examples/tooltip.html"
   ],
   "ix-tree": [

package/build/component-usage.json

@@ -12,28 +12,28 @@
   "/src/preview-examples/add-icons.html": [
     "ix-icon"
   ],
-  "/src/preview-examples/application-app-switch.html": [
+  "/src/preview-examples/application-advanced.html": [
     "ix-application",
     "ix-application-header",
     "ix-avatar",
     "ix-content",
     "ix-content-header",
-    "ix-dropdown-button",
-    "ix-dropdown-item",
     "ix-menu",
-    "ix-menu-item"
+    "ix-menu-about",
+    "ix-menu-category",
+    "ix-menu-item",
+    "ix-menu-settings"
   ],
-  "/src/preview-examples/application-advanced.html": [
+  "/src/preview-examples/application-app-switch.html": [
     "ix-application",
     "ix-application-header",
     "ix-avatar",
     "ix-content",
     "ix-content-header",
+    "ix-dropdown-button",
+    "ix-dropdown-item",
     "ix-menu",
-    "ix-menu-about",
-    "ix-menu-category",
-    "ix-menu-item",
-    "ix-menu-settings"
+    "ix-menu-item"
   ],
   "/src/preview-examples/application-breakpoints.html": [
     "ix-application",
@@ -505,6 +505,12 @@
   "/src/preview-examples/message.html": [
     "ix-button"
   ],
+  "/src/preview-examples/modal-close.html": [
+    "ix-button",
+    "ix-modal-content",
+    "ix-modal-footer",
+    "ix-modal-header"
+  ],
   "/src/preview-examples/modal-form-ix-button-submit.html": [
     "ix-button",
     "ix-input",
@@ -686,6 +692,7 @@
   ],
   "/src/preview-examples/theme-switcher.html": [
     "ix-button",
+    "ix-checkbox",
     "ix-col",
     "ix-layout-grid",
     "ix-row",
@@ -770,6 +777,11 @@
   "/src/preview-examples/toggle.html": [
     "ix-toggle"
   ],
+  "/src/preview-examples/tooltip-with-icon.html": [
+    "ix-button",
+    "ix-icon",
+    "ix-tooltip"
+  ],
   "/src/preview-examples/tooltip.html": [
     "ix-button",
     "ix-tooltip"

package/build/docs/autogenerated/api/ix-date-input/api.mdx

@@ -388,6 +388,51 @@ If not set there will be no restriction.`}</ReactMarkdown>
     {`false`}
   </ApiTable.Code>
 
+</ApiTable>
+<ApiTable id="property-suppressSubmitOnEnter">
+  <ApiTable.PropertyHeader name="suppressSubmitOnEnter" singleFramework="">
+      
+  </ApiTable.PropertyHeader>
+
+  <ApiTable.Text name="Description">
+    <ReactMarkdown>{`If false, pressing Enter will submit the form (if inside a form).
+Set to true to suppress submit on Enter.`}</ReactMarkdown>
+  </ApiTable.Text>
+
+  <ApiTable.Code name="Attribute">
+    {`suppress-submit-on-enter`}
+  </ApiTable.Code>
+
+  <ApiTable.Code name="Type">
+   {`boolean`}
+  </ApiTable.Code>
+
+  <ApiTable.Code name="Default">
+    {`false`}
+  </ApiTable.Code>
+
+</ApiTable>
+<ApiTable id="property-textAlignment">
+  <ApiTable.PropertyHeader name="textAlignment" singleFramework="">
+      
+  </ApiTable.PropertyHeader>
+
+  <ApiTable.Text name="Description">
+    <ReactMarkdown>{`Text alignment within the date input. 'start' aligns the text to the start of the input, 'end' aligns the text to the end of the input.`}</ReactMarkdown>
+  </ApiTable.Text>
+
+  <ApiTable.Code name="Attribute">
+    {`text-alignment`}
+  </ApiTable.Code>
+
+  <ApiTable.Code name="Type">
+   {`"end" | "start"`}
+  </ApiTable.Code>
+
+  <ApiTable.Code name="Default">
+    {`'start'`}
+  </ApiTable.Code>
+
 </ApiTable>
 <ApiTable id="property-validText">
   <ApiTable.PropertyHeader name="validText" singleFramework="">

package/build/docs/autogenerated/api/ix-date-input/props.mdx

@@ -379,6 +379,51 @@ If not set there will be no restriction.`}</ReactMarkdown>
     {`false`}
   </ApiTable.Code>
 
+</ApiTable>
+<ApiTable id="property-suppressSubmitOnEnter">
+  <ApiTable.PropertyHeader name="suppressSubmitOnEnter" singleFramework="">
+      
+  </ApiTable.PropertyHeader>
+
+  <ApiTable.Text name="Description">
+    <ReactMarkdown>{`If false, pressing Enter will submit the form (if inside a form).
+Set to true to suppress submit on Enter.`}</ReactMarkdown>
+  </ApiTable.Text>
+
+  <ApiTable.Code name="Attribute">
+    {`suppress-submit-on-enter`}
+  </ApiTable.Code>
+
+  <ApiTable.Code name="Type">
+   {`boolean`}
+  </ApiTable.Code>
+
+  <ApiTable.Code name="Default">
+    {`false`}
+  </ApiTable.Code>
+
+</ApiTable>
+<ApiTable id="property-textAlignment">
+  <ApiTable.PropertyHeader name="textAlignment" singleFramework="">
+      
+  </ApiTable.PropertyHeader>
+
+  <ApiTable.Text name="Description">
+    <ReactMarkdown>{`Text alignment within the date input. 'start' aligns the text to the start of the input, 'end' aligns the text to the end of the input.`}</ReactMarkdown>
+  </ApiTable.Text>
+
+  <ApiTable.Code name="Attribute">
+    {`text-alignment`}
+  </ApiTable.Code>
+
+  <ApiTable.Code name="Type">
+   {`"end" | "start"`}
+  </ApiTable.Code>
+
+  <ApiTable.Code name="Default">
+    {`'start'`}
+  </ApiTable.Code>
+
 </ApiTable>
 <ApiTable id="property-validText">
   <ApiTable.PropertyHeader name="validText" singleFramework="">

package/build/docs/autogenerated/api/ix-input/api.mdx

@@ -270,6 +270,51 @@ import ReactMarkdown from 'react-markdown';
   </ApiTable.Code>
 
 
+</ApiTable>
+<ApiTable id="property-suppressSubmitOnEnter">
+  <ApiTable.PropertyHeader name="suppressSubmitOnEnter" singleFramework="">
+      
+  </ApiTable.PropertyHeader>
+
+  <ApiTable.Text name="Description">
+    <ReactMarkdown>{`If false, pressing Enter will submit the form (if inside a form).
+Set to true to suppress submit on Enter.`}</ReactMarkdown>
+  </ApiTable.Text>
+
+  <ApiTable.Code name="Attribute">
+    {`suppress-submit-on-enter`}
+  </ApiTable.Code>
+
+  <ApiTable.Code name="Type">
+   {`boolean`}
+  </ApiTable.Code>
+
+  <ApiTable.Code name="Default">
+    {`false`}
+  </ApiTable.Code>
+
+</ApiTable>
+<ApiTable id="property-textAlignment">
+  <ApiTable.PropertyHeader name="textAlignment" singleFramework="">
+      
+  </ApiTable.PropertyHeader>
+
+  <ApiTable.Text name="Description">
+    <ReactMarkdown>{`Text alignment within the input. 'start' aligns the text to the start of the input, 'end' aligns the text to the end of the input.`}</ReactMarkdown>
+  </ApiTable.Text>
+
+  <ApiTable.Code name="Attribute">
+    {`text-alignment`}
+  </ApiTable.Code>
+
+  <ApiTable.Code name="Type">
+   {`"end" | "start"`}
+  </ApiTable.Code>
+
+  <ApiTable.Code name="Default">
+    {`'start'`}
+  </ApiTable.Code>
+
 </ApiTable>
 <ApiTable id="property-type">
   <ApiTable.PropertyHeader name="type" singleFramework="">

package/build/docs/autogenerated/api/ix-input/props.mdx

@@ -261,6 +261,51 @@
   </ApiTable.Code>
 
 
+</ApiTable>
+<ApiTable id="property-suppressSubmitOnEnter">
+  <ApiTable.PropertyHeader name="suppressSubmitOnEnter" singleFramework="">
+      
+  </ApiTable.PropertyHeader>
+
+  <ApiTable.Text name="Description">
+    <ReactMarkdown>{`If false, pressing Enter will submit the form (if inside a form).
+Set to true to suppress submit on Enter.`}</ReactMarkdown>
+  </ApiTable.Text>
+
+  <ApiTable.Code name="Attribute">
+    {`suppress-submit-on-enter`}
+  </ApiTable.Code>
+
+  <ApiTable.Code name="Type">
+   {`boolean`}
+  </ApiTable.Code>
+
+  <ApiTable.Code name="Default">
+    {`false`}
+  </ApiTable.Code>
+
+</ApiTable>
+<ApiTable id="property-textAlignment">
+  <ApiTable.PropertyHeader name="textAlignment" singleFramework="">
+      
+  </ApiTable.PropertyHeader>
+
+  <ApiTable.Text name="Description">
+    <ReactMarkdown>{`Text alignment within the input. 'start' aligns the text to the start of the input, 'end' aligns the text to the end of the input.`}</ReactMarkdown>
+  </ApiTable.Text>
+
+  <ApiTable.Code name="Attribute">
+    {`text-alignment`}
+  </ApiTable.Code>
+
+  <ApiTable.Code name="Type">
+   {`"end" | "start"`}
+  </ApiTable.Code>
+
+  <ApiTable.Code name="Default">
+    {`'start'`}
+  </ApiTable.Code>
+
 </ApiTable>
 <ApiTable id="property-type">
   <ApiTable.PropertyHeader name="type" singleFramework="">

package/build/docs/autogenerated/api/ix-number-input/api.mdx

@@ -7,6 +7,30 @@ import ReactMarkdown from 'react-markdown';
 
 ### Properties
 
+<ApiTable id="property-allowEmptyValueChange">
+  <ApiTable.PropertyHeader name="allowEmptyValueChange" singleFramework="">
+      <SinceTag message={`4.1.0`} />
+      
+  </ApiTable.PropertyHeader>
+
+  <ApiTable.Text name="Description">
+    <ReactMarkdown>{`If true, the valueChange event will return null instead of 0 for an empty input state.
+This property will be removed in 5.0.0 and this behaviour will be default.`}</ReactMarkdown>
+  </ApiTable.Text>
+
+  <ApiTable.Code name="Attribute">
+    {`allow-empty-value-change`}
+  </ApiTable.Code>
+
+  <ApiTable.Code name="Type">
+   {`boolean`}
+  </ApiTable.Code>
+
+  <ApiTable.Code name="Default">
+    {`false`}
+  </ApiTable.Code>
+
+</ApiTable>
 <ApiTable id="property-allowedCharactersPattern">
   <ApiTable.PropertyHeader name="allowedCharactersPattern" singleFramework="">
   </ApiTable.PropertyHeader>
@@ -237,7 +261,7 @@ import ReactMarkdown from 'react-markdown';
   </ApiTable.PropertyHeader>
 
   <ApiTable.Text name="Description">
-    <ReactMarkdown>{`Indicates if the field is required`}</ReactMarkdown>
+    <ReactMarkdown>{`Indicates if the field is required. When required, empty values (undefined) are not accepted.`}</ReactMarkdown>
   </ApiTable.Text>
 
   <ApiTable.Code name="Attribute">
@@ -291,11 +315,11 @@ import ReactMarkdown from 'react-markdown';
 </ApiTable>
 <ApiTable id="property-step">
   <ApiTable.PropertyHeader name="step" singleFramework="">
-      <SinceTag message={`3.0.0`} />
+      
   </ApiTable.PropertyHeader>
 
   <ApiTable.Text name="Description">
-    <ReactMarkdown>{`Step value to increment or decrement the input value`}</ReactMarkdown>
+    <ReactMarkdown>{`Step value to increment or decrement the input value. Default step value is 1.`}</ReactMarkdown>
   </ApiTable.Text>
 
   <ApiTable.Code name="Attribute">
@@ -306,6 +330,54 @@ import ReactMarkdown from 'react-markdown';
    {`number | string | undefined`}
   </ApiTable.Code>
 
+  <ApiTable.Code name="Default">
+    {`1`}
+  </ApiTable.Code>
+
+</ApiTable>
+<ApiTable id="property-suppressSubmitOnEnter">
+  <ApiTable.PropertyHeader name="suppressSubmitOnEnter" singleFramework="">
+      
+  </ApiTable.PropertyHeader>
+
+  <ApiTable.Text name="Description">
+    <ReactMarkdown>{`If false, pressing Enter will submit the form (if inside a form).
+Set to true to suppress submit on Enter.`}</ReactMarkdown>
+  </ApiTable.Text>
+
+  <ApiTable.Code name="Attribute">
+    {`suppress-submit-on-enter`}
+  </ApiTable.Code>
+
+  <ApiTable.Code name="Type">
+   {`boolean`}
+  </ApiTable.Code>
+
+  <ApiTable.Code name="Default">
+    {`false`}
+  </ApiTable.Code>
+
+</ApiTable>
+<ApiTable id="property-textAlignment">
+  <ApiTable.PropertyHeader name="textAlignment" singleFramework="">
+      
+  </ApiTable.PropertyHeader>
+
+  <ApiTable.Text name="Description">
+    <ReactMarkdown>{`Text alignment within the number input. 'start' aligns the text to the start of the input, 'end' aligns the text to the end of the input.`}</ReactMarkdown>
+  </ApiTable.Text>
+
+  <ApiTable.Code name="Attribute">
+    {`text-alignment`}
+  </ApiTable.Code>
+
+  <ApiTable.Code name="Type">
+   {`"end" | "start"`}
+  </ApiTable.Code>
+
+  <ApiTable.Code name="Default">
+    {`'end'`}
+  </ApiTable.Code>
 
 </ApiTable>
 <ApiTable id="property-validText">
@@ -332,7 +404,7 @@ import ReactMarkdown from 'react-markdown';
   </ApiTable.PropertyHeader>
 
   <ApiTable.Text name="Description">
-    <ReactMarkdown>{`The value of the input field`}</ReactMarkdown>
+    <ReactMarkdown>{`The value of the input field. Supports numeric values, scientific notation (1E6, 1E-6), or undefined for empty.`}</ReactMarkdown>
   </ApiTable.Text>
 
   <ApiTable.Code name="Attribute">
@@ -340,7 +412,7 @@ import ReactMarkdown from 'react-markdown';
   </ApiTable.Code>
 
   <ApiTable.Code name="Type">
-   {`number`}
+   {`number | undefined`}
   </ApiTable.Code>
 
   <ApiTable.Code name="Default">

package/build/docs/autogenerated/api/ix-number-input/props.mdx

@@ -1,3 +1,27 @@
+<ApiTable id="property-allowEmptyValueChange">
+  <ApiTable.PropertyHeader name="allowEmptyValueChange" singleFramework="">
+      <SinceTag message={`4.1.0`} />
+      
+  </ApiTable.PropertyHeader>
+
+  <ApiTable.Text name="Description">
+    <ReactMarkdown>{`If true, the valueChange event will return null instead of 0 for an empty input state.
+This property will be removed in 5.0.0 and this behaviour will be default.`}</ReactMarkdown>
+  </ApiTable.Text>
+
+  <ApiTable.Code name="Attribute">
+    {`allow-empty-value-change`}
+  </ApiTable.Code>
+
+  <ApiTable.Code name="Type">
+   {`boolean`}
+  </ApiTable.Code>
+
+  <ApiTable.Code name="Default">
+    {`false`}
+  </ApiTable.Code>
+
+</ApiTable>
 <ApiTable id="property-allowedCharactersPattern">
   <ApiTable.PropertyHeader name="allowedCharactersPattern" singleFramework="">
   </ApiTable.PropertyHeader>
@@ -228,7 +252,7 @@
   </ApiTable.PropertyHeader>
 
   <ApiTable.Text name="Description">
-    <ReactMarkdown>{`Indicates if the field is required`}</ReactMarkdown>
+    <ReactMarkdown>{`Indicates if the field is required. When required, empty values (undefined) are not accepted.`}</ReactMarkdown>
   </ApiTable.Text>
 
   <ApiTable.Code name="Attribute">
@@ -282,11 +306,11 @@
 </ApiTable>
 <ApiTable id="property-step">
   <ApiTable.PropertyHeader name="step" singleFramework="">
-      <SinceTag message={`3.0.0`} />
+      
   </ApiTable.PropertyHeader>
 
   <ApiTable.Text name="Description">
-    <ReactMarkdown>{`Step value to increment or decrement the input value`}</ReactMarkdown>
+    <ReactMarkdown>{`Step value to increment or decrement the input value. Default step value is 1.`}</ReactMarkdown>
   </ApiTable.Text>
 
   <ApiTable.Code name="Attribute">
@@ -297,6 +321,54 @@
    {`number | string | undefined`}
   </ApiTable.Code>
 
+  <ApiTable.Code name="Default">
+    {`1`}
+  </ApiTable.Code>
+
+</ApiTable>
+<ApiTable id="property-suppressSubmitOnEnter">
+  <ApiTable.PropertyHeader name="suppressSubmitOnEnter" singleFramework="">
+      
+  </ApiTable.PropertyHeader>
+
+  <ApiTable.Text name="Description">
+    <ReactMarkdown>{`If false, pressing Enter will submit the form (if inside a form).
+Set to true to suppress submit on Enter.`}</ReactMarkdown>
+  </ApiTable.Text>
+
+  <ApiTable.Code name="Attribute">
+    {`suppress-submit-on-enter`}
+  </ApiTable.Code>
+
+  <ApiTable.Code name="Type">
+   {`boolean`}
+  </ApiTable.Code>
+
+  <ApiTable.Code name="Default">
+    {`false`}
+  </ApiTable.Code>
+
+</ApiTable>
+<ApiTable id="property-textAlignment">
+  <ApiTable.PropertyHeader name="textAlignment" singleFramework="">
+      
+  </ApiTable.PropertyHeader>
+
+  <ApiTable.Text name="Description">
+    <ReactMarkdown>{`Text alignment within the number input. 'start' aligns the text to the start of the input, 'end' aligns the text to the end of the input.`}</ReactMarkdown>
+  </ApiTable.Text>
+
+  <ApiTable.Code name="Attribute">
+    {`text-alignment`}
+  </ApiTable.Code>
+
+  <ApiTable.Code name="Type">
+   {`"end" | "start"`}
+  </ApiTable.Code>
+
+  <ApiTable.Code name="Default">
+    {`'end'`}
+  </ApiTable.Code>
 
 </ApiTable>
 <ApiTable id="property-validText">
@@ -323,7 +395,7 @@
   </ApiTable.PropertyHeader>
 
   <ApiTable.Text name="Description">
-    <ReactMarkdown>{`The value of the input field`}</ReactMarkdown>
+    <ReactMarkdown>{`The value of the input field. Supports numeric values, scientific notation (1E6, 1E-6), or undefined for empty.`}</ReactMarkdown>
   </ApiTable.Text>
 
   <ApiTable.Code name="Attribute">
@@ -331,7 +403,7 @@
   </ApiTable.Code>
 
   <ApiTable.Code name="Type">
-   {`number`}
+   {`number | undefined`}
   </ApiTable.Code>
 
   <ApiTable.Code name="Default">