igniteui-dockmanager 1.18.1 → 2.0.0-RC.1

package/README.md

@@ -2,6 +2,9 @@
 
 [Ignite UI Dock Manager Web Component](https://www.infragistics.com/) provides means to manage the layout of your application through panes, allowing your end-users to customize it further by pinning, resizing, moving and hiding panes.
 
+> [!IMPORTANT]
+> **Version 2.0+ Notice:** The Dock Manager has been migrated from Stencil to **Lit**. For the legacy Stencil-based version, please refer to the [1.18.x branch](https://github.com/IgniteUI/dock-manager/tree/1.18.x).
+
 ## NPM Package
 
 You can include the Ignite UI Dock Manager Web Component in your project as a dependency using the NPM package.
@@ -12,12 +15,26 @@ npm install igniteui-dockmanager --save
 
 ## Usage
 
-In order to use the Ignite UI Dock Manager Web Component it is necessary to import and call the `defineCustomElements()` function:
+### Lit Version (v2.0+)
+
+In the new Lit-based version, you simply import the component and call the `defineComponents()` function:
+
+```ts
+import IgcDockManagerComponent, { defineComponents } from 'igniteui-dockmanager';
+
+defineComponents(IgcDockManagerComponent);
+
+```
+
+### Legacy Stencil Version (v1.18.x)
+
+If you are using the version from the `1.18.x` branch, it is necessary to import and call the `defineCustomElements()` function:
 
 ```ts
 import { defineCustomElements } from 'igniteui-dockmanager/loader';
 
 defineCustomElements();
+
 ```
 
 Once the Dock Manager is imported, you can add it on the page:
@@ -29,6 +46,27 @@ Once the Dock Manager is imported, you can add it on the page:
 
 More information on how to use the Ignite UI Dock Manager Web Component can be found [here](https://infragistics.com/products/ignite-ui-web-components/web-components/components/dock-manager.html).
 
+### Localization
+
+To localize the Dock Manager strings, install the peer dependency `igniteui-i18n-resources` and register a language bundle with `igniteui-i18n-core`:
+
+```ts
+import { registerI18n } from 'igniteui-i18n-core';
+import { DockManagerResourceStringsES } from 'igniteui-i18n-resources';
+
+registerI18n(DockManagerResourceStringsES, 'es');
+```
+
+## Branching & Maintenance
+
+To ensure stability for our customers, we maintain the following branch structure:
+
+| Branch | Status | Framework | Support |
+| --- | --- | --- | --- |
+| `master` | Stable | **Lit** | Active Development |
+| `develop` | Bleeding Edge | **Lit** | Integration |
+| `1.18.x` | Legacy LTS | **Stencil** | Security & Critical Bug fixes Only |
+
 ## Support
 
 Developer support is provided as part of the commercial, paid-for license via [Infragistics Forums](https://www.infragistics.com/community/forums/), or via Chat & Phone with a Priority Support license.  To acquire a license for paid support or Priority Support, please visit this [page](https://www.infragistics.com/how-to-buy/product-pricing#developers).
@@ -43,4 +81,4 @@ To acquire a license for commercial usage, please [register for trial](https://w
 
 © Copyright 2020 INFRAGISTICS. All Rights Reserved. 
 The Infragistics Ultimate license & copyright applies to this distribution. 
-For information on that license, please go to our website [https://www.infragistics.com/legal/license](https://www.infragistics.com/legal/license).
+For information on that license, please go to our website [https://www.infragistics.com/legal/license](https://www.infragistics.com/legal/license).