Feat(web-twig): Deprecate isFullWidth prop in Dropdown component

* use `fullWidthMode` prop instead
lmc-eu · Feb 3, 2023 · 544264d · 544264d
1 parent 6f9bf3a
commit 544264d
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 9 deletions.
diff --git a/packages/web-twig/src/Resources/components/Dropdown/Dropdown.twig b/packages/web-twig/src/Resources/components/Dropdown/Dropdown.twig
@@ -29,6 +29,9 @@
 {%- set _classNames = [ _rootClassName, _fullWidthClassName, _class ] | merge(_placementClassNames[_placement]) -%}
 
 {# Deprecations #}
+{% if _isFullWidth %}
+    {% deprecated 'Dropdown: The "isFullWidth" property is deprecated, use "fullWidthMode" instead.' %}
+{% endif %}
 {% if _breakpoint %}
     {% deprecated 'Dropdown: The "breakpoint" property is deprecated, use "fullWidthMode" instead.' %}
 {% endif %}

diff --git a/packages/web-twig/src/Resources/components/Dropdown/README.md b/packages/web-twig/src/Resources/components/Dropdown/README.md
@@ -56,15 +56,15 @@ attributes to register trigger events.
 
 ### Dropdown
 
-| Prop name       | Type                                                     | Default       | Required | Description                                                                                 |
-| --------------- | -------------------------------------------------------- | ------------- | -------- | ------------------------------------------------------------------------------------------- |
-| `id`            | `string`                                                 | -             | yes      | Dropdown ID                                                                                 |
-| `breakpoint`    | `string`                                                 | -             | no       | [**DEPRECATED**][deprecated] in favor of `fullWidthMode`; Breakpoint level [tablet,desktop] |
-| `fullWidthMode` | `string`                                                 | -             | no       | Full-width mode [off,mobile-only,all]                                                       |
-| `class`         | `string`                                                 | `null`        | no       | Custom CSS class                                                                            |
-| `elementType`   | `string`                                                 | `div`         | no       | HTML tag to render                                                                          |
-| `isFullWidth`   | `boolean`                                                | `false`       | no       | Whether is component displayed in full width                                                |
-| `placement`     | [`bottom-left`, `bottom-right`, `top-left`, `top-right`] | `bottom-left` | no       | Alignment of the component                                                                  |
+| Prop name       | Type                                                     | Default       | Required | Description                                                                                            |
+| --------------- | -------------------------------------------------------- | ------------- | -------- | ------------------------------------------------------------------------------------------------------ |
+| `id`            | `string`                                                 | -             | yes      | Dropdown ID                                                                                            |
+| `breakpoint`    | `string`                                                 | -             | no       | [**DEPRECATED**][deprecated] in favor of `fullWidthMode`; Breakpoint level [tablet,desktop]            |
+| `fullWidthMode` | `string`                                                 | -             | no       | Full-width mode [off,mobile-only,all]                                                                  |
+| `class`         | `string`                                                 | `null`        | no       | Custom CSS class                                                                                       |
+| `elementType`   | `string`                                                 | `div`         | no       | HTML tag to render                                                                                     |
+| `isFullWidth`   | `boolean`                                                | `false`       | no       | [**DEPRECATED**][deprecated] in favor of `fullWidthMode`; Whether is component displayed in full width |
+| `placement`     | [`bottom-left`, `bottom-right`, `top-left`, `top-right`] | `bottom-left` | no       | Alignment of the component                                                                             |
 
 ### Trigger attributes