fix(breadcrumb): generation doc

ovh · Dec 13, 2023 · 8c84f69 · 8c84f69
1 parent 641002e
commit 8c84f69
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 4 deletions.
diff --git a/packages/components/breadcrumb/documentation/specifications/spec.md b/packages/components/breadcrumb/documentation/specifications/spec.md
@@ -11,6 +11,10 @@
 ### OdsBreadcrumbAttributeItem
 |Name | Type | Required | Default | Description|
 |---|---|:---:|---|---|
+|**`disabled`** | _boolean_ |  |  | Item should be disabled or not|
 |**`href`** | _string_ | ✴️ |  | Item link to redirect to|
 |**`icon`** | `ODS_ICON_NAME` |  |  | Icon to display|
-|**`label`** | _string_ |  |  | Text to display|
+|**`label`** | _string_ |  |  | Text to display|
+|**`referrerpolicy`** | `ODS_LINK_REFERRER_POLICY` |  |  | Link referrer policy|
+|**`rel`** | _string_ |  |  | Link relationship|
+|**`target`** | `OdsHTMLAnchorElementTarget` |  |  | Specifies where to open the link|
diff --git a/packages/components/breadcrumb/src/components/osds-breadcrumb-item/osds-breadcrumb-item.tsx b/packages/components/breadcrumb/src/components/osds-breadcrumb-item/osds-breadcrumb-item.tsx
@@ -1,5 +1,6 @@
 import type { OdsBreadcrumbItemAttribute } from './interfaces/attributes';
 
+import type { OdsHTMLAnchorElementTarget } from '@ovhcloud/ods-common-core';
 import type { ODS_LINK_REFERRER_POLICY } from '@ovhcloud/ods-component-link';
 import { ODS_THEME_COLOR_INTENT } from '@ovhcloud/ods-common-theming';
 import { ODS_ICON_NAME, ODS_ICON_SIZE } from '@ovhcloud/ods-component-icon';
@@ -50,8 +51,8 @@ export class OsdsBreadcrumbItem implements OdsBreadcrumbItemAttribute {
   /** @see OdsBreadcrumbItemAttribute.rel */
   @Prop({ reflect: true }) rel?: HTMLLinkElement['rel'];
 
-  /** @see OdsBreadcrumbItemAttribute.disabled */
-  @Prop({ reflect: true }) target = DEFAULT_ATTRIBUTE.target;
+  /** @see OdsBreadcrumbItemAttribute.target */
+  @Prop({ reflect: true }) target?: OdsHTMLAnchorElementTarget = DEFAULT_ATTRIBUTE.target;
 
   /** @see OdsBreadcrumbItemEvent.odsBreadcrumbItemCollapsedClick */
   @Event() odsBreadcrumbItemCollapsedClick!: EventEmitter<void>;

diff --git a/packages/components/breadcrumb/src/components/osds-breadcrumb/interfaces/attributes.ts b/packages/components/breadcrumb/src/components/osds-breadcrumb/interfaces/attributes.ts
@@ -16,7 +16,7 @@ interface OdsBreadcrumbAttributeItem {
   /**  Link relationship */
   rel?: HTMLLinkElement['rel'];
   /** Specifies where to open the link */
-  target: OdsHTMLAnchorElementTarget;
+  target?: OdsHTMLAnchorElementTarget;
 }
 
 interface OdsBreadcrumbAttribute {