Skip to content

Commit

Permalink
docs(site): migration guide fixes
Browse files Browse the repository at this point in the history
Co-authored-by: alesun <alesun@exadel.com>
Co-authored-by: Feoktist Shovchko <fshovchko@exadel.com>
Co-authored-by: yadamska <yadamska@exadel.com>
  • Loading branch information
4 people committed Nov 3, 2024
1 parent 5184325 commit 685cf99
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 14 deletions.
3 changes: 2 additions & 1 deletion site/src/navigation/sidebar/sidebar-content.less
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,8 @@ esl-d-sidebar {

height: 100%;
margin-top: 0;
@media @md-lg {

@media @md-xl {
margin-top: 30px;
}
}
Expand Down
2 changes: 1 addition & 1 deletion site/views/_includes/navigation/sidebar-item.njk
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@
{% endmacro %}

{% macro badgeByTags(tags, isDraftCollection) %}
{# Tags chaecks ordered by priority, due to displaying single badge #}
{# Tags checks ordered by priority, due to displaying single badge #}
{% if tags.includes('deprecated') %}
<span class="badge badge-sidebar badge-img badge-deprecated" title="Deprecated component" aria-label="Deprecated component"></span>
{% elif tags.includes('draft') and not isDraftCollection %}
Expand Down
27 changes: 15 additions & 12 deletions site/views/blogs/ESL v5.0.0 Migartion Guide.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
layout: content
name: ESL v5.0.0 Migartion Guide
name: ESL v5.0.0 Migration Guide
title: Migrating from ESL v4.*.* to ESL v5.0.0
tags: [news, blogs, draft]
date: 2024-11-31
date: 2024-10-31
---

The ESL version 5.0.0 have just been released and it comes with a lot of new features and improvements.
The ESL version 5.0.0 has just been released and it comes with a lot of new features and improvements.
This guide will help you to migrate your existing ESL v4.\*.* project to ESL v5.0.0.

---
Expand All @@ -23,16 +23,16 @@ The points not marked with `🔧` in the breaking changes section are covered by
- ### Browser Support
ESL v5.0.0 no longer supports IE11 and ES5 target.
ESL UI site renderer and ESL polyfills no longer support Edge old versions and ES6 polyfils.
In case by some reason you still need to support IE11 or ES5 target you should use proper transpilation and polyfilling tools on your side.
In case for some reason you still need to support IE11 or ES5 target you should use proper transpilation and polyfilling tools on your side.

- ### ESL Core / ESL Utils
- #### Direct imports changes
- 🔧 `prop`, `attr`, `boolAttr`, `jsonAttr`, `listen` no longer available in `esl-base-element` and `esl-mixin-element` exports,
- 🔧 `prop`, `attr`, `boolAttr`, `jsonAttr`, `listen` are no longer available in `esl-base-element` and `esl-mixin-element` exports,
to use them you should import them from `esl-utils/decorators` directly or from the library root.
- #### ESL Utils API Changes
- `Rect` utility object is now immutable, so you can't change its properties directly.
If you modify the `Rect` object troug builtin methods, you will get a new object with the updated properties.
- #### ESL Utils Retired Functianality
If you modify the `Rect` object trough builtin methods, you will get a new object with the updated properties.
- #### ESL Utils Retired Functionality
- `DeviceDetector.TOUCH_EVENTS` and `TOUCH_EVENTS` are retired from the `device-detector` module.
- Note that the `DeviceDetector` class is now deprecated. Use direct checks instead.
- `createZIndexIframe` and `is-fixes` module are no longer available due to drop of IE11 support.
Expand All @@ -50,23 +50,26 @@ The points not marked with `🔧` in the breaking changes section are covered by
- ESL Media Query consume functionality of `SynteticEventTarget` so `addListener` and `removeListener` shorthand are no longer supported.
Use `addEventListener` and `removeEventListener` instead.

- ### ESL Togglables and Triggers
- #### ESL Togglables API Changes
- ### ESL Toggleables and Triggers
- #### ESL Toggleables API Changes
- `ToggleableActionParams` alias of `ESLToggleableActionParams` is no longer supported.
- `onBeforeShow` and `onBeforeHide` have retired. The constraint now inside `shouldShow`/`shouldHide` methods.
Note that `activator` property change now is the part of main togglable flow.
- `this.open` of Toggleables does not updating util super.onShow/super.onHide called.
Note that `activator` property change now is the part of main toggleable flow.
- `this.open` of Toggleables doesn't update until super.onShow/super.onHide is called.
Make sure you update `this.open` synchronously or manually notify consumers in case the super call of `onShow/onHide` should be postponed.
- #### ESL Triggers API Changes
- `ESLTrigger` does not have target defined to `::next` by default. You should always define the target explicitly.
- #### ESL Panel and Panel Group
- `fallback-duration` is no longer in the JSX shape of `ESLPanel` and `ESLPanelGroup`.

- ### ESL Footnotes
- `ESLNote` now based on `ESLBaseTrigger` so active marker now called `active` instead of `tooltip-shown`.

- ### ESL Image
- CSS aspect-ratio styles are no longer distributed with ESL Image.
You should define them in your project styles or use a separate package for that.
- Note that ESL Image is now deprecated. Consider using native Image element with optional help from `esl-image-utils` module.

- ### ESL Media
- `load-cls-target`, `load-cls-accepted` and `load-cls-declined` use `load-condition-class` and `load-condition-class-target` instead.
- `disabled` marker no longer supported use `lazy="manual"` instead (the `force` option of `play` method works the same way with new lazy option).
- `disabled` marker is no longer supported, use `lazy="manual"` instead (the `force` option of `play` method works the same way with the new lazy option).

0 comments on commit 685cf99

Please sign in to comment.