Skip to content

Commit

Permalink
docs: features documentation (#7815)
Browse files Browse the repository at this point in the history
* docs: features documentation

* chore: remove empty row from table

---------

Co-authored-by: Nayden Naydenov <[email protected]>
  • Loading branch information
nnaydenow and Nayden Naydenov authored Nov 17, 2023
1 parent 98a0cf1 commit c103b81
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions docs/1-getting-started/06-using-features.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Import the feature file from the respective NPM package:

`import "@ui5/<PACKAGE-NAME>/dist/features/<FEATURE-NAME>.js`

## Component features
## Component features

Currently, only a few components offer additional features:

Expand All @@ -31,22 +31,28 @@ Currently, only a few components offer additional features:
| `localization` | Multiple (`ui5-date-picker`, etc...) | `@ui5/webcomponents-localization/dist/features/calendar/Japanese.js` | Japanese calendar support |
| `localization` | Multiple (`ui5-date-picker`, etc...) | `@ui5/webcomponents-localization/dist/features/calendar/Persian.js` | Persian calendar support |

<b>Note:</b> Features must be imported before all components modules,
so that the feature is enabled before the components' definition.

For example:

```js
import "@ui5/webcomponents/dist/features/ColorPaletteMoreColors.js;";

import "@ui5/webcomponents/dist/Button.js";
import "@ui5/webcomponents/dist/Link.js";
import "@ui5/webcomponents/dist/Input.js";
```

## Framework features
## Framework features

| Package | Affects | Feature Import | Description |
|----------------|---------------------------------------------------|----------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------|
| `base` | Framework | `@ui5/webcomponents-base/dist/features/OpenUI5Support.js` | Integration with the OpenUI5 framework, allowing synchronization and resources re-use |
| `base` | Multiple components within all libraries | `@ui5/webcomponents-base/dist/features/F6Navigation.js` | Support for F6 fast groups navigation |
| `base` | Date related components | `@ui5/webcomponents-base/dist/features/LegacyDateFormats.js` | Support for legacy date formats |
|

Framework-level features must be imported before all components modules,
<b>Note:</b> Framework-level features must be imported before all components modules,
so that the feature is enabled upon framework boot, before the components' definition.

For example:
Expand Down

0 comments on commit c103b81

Please sign in to comment.