Feat(web-twig): Deprecate optional goBackTitle in Breadcrumbs

refs #DS-834
lmc-eu · Aug 28, 2023 · b469abe · b469abe
1 parent a6dc3af
commit b469abe
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 5 deletions.
diff --git a/packages/web-twig/src/Resources/components/Breadcrumbs/Breadcrumbs.twig b/packages/web-twig/src/Resources/components/Breadcrumbs/Breadcrumbs.twig
@@ -11,6 +11,11 @@
 {%- set _styleProps = useStyleProps(props) -%}
 {%- set _classNames = [ _rootClassName, _styleProps.className ] -%}
 
+{# Deprecations #}
+{% if not _goBackTitle %}
+    {% deprecated 'Breadcrumbs: The "goBackTitle" property will be required starting from the next major version.' %}
+{% endif %}
+
 <{{ _elementType }} {{ mainProps(props) }} {{ styleProp(_styleProps) }} {{ classProp(_classNames) }} aria-label="Breadcrumb">
 {% apply spaceless %}
     {%- if _items|length > 0 -%}

diff --git a/packages/web-twig/src/Resources/components/Breadcrumbs/README.md b/packages/web-twig/src/Resources/components/Breadcrumbs/README.md
@@ -95,11 +95,11 @@ content can be overridden by any custom block content.
 
 ## Breadcrumbs
 
-| Name          | Type     | Default | Required | Description                                                                                                                                                                                 |
-| ------------- | -------- | ------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `elementType` | `string` | `nav`   | ✕        | HTML tag to render                                                                                                                                                                          |
-| `goBackTitle` | `string` | —       | ✕        | Title/translation for back link to previous page on mobile. It's essential to be set along with items. If items property is not passed, backlink is to be created within children property. |
-| `items`       | `array`  | `[]`    | ✕        | Navigation menu items                                                                                                                                                                       |
+| Name          | Type     | Default | Required | Description                                                                                                                                                                                                                                                                       |
+| ------------- | -------- | ------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `elementType` | `string` | `nav`   | ✕        | HTML tag to render                                                                                                                                                                                                                                                                |
+| `goBackTitle` | `string` | —       | ✕        | Title/translation for back link to previous page on mobile. It's essential to be set along with items. If items property is not passed, backlink is to be created within children property. [**Optional DEPRECATED**][Deprecated] Will be **required** in the next major version. |
+| `items`       | `array`  | `[]`    | ✕        | Navigation menu items                                                                                                                                                                                                                                                             |
 
 You can add `id`, `data-*` or `aria-*` attributes to further extend the component's
 descriptiveness and accessibility. Also, UNSAFE styling props are available,