-
Notifications
You must be signed in to change notification settings - Fork 18
docs: optional-deps guide #294
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
danielleroux
wants to merge
1
commit into
development
Choose a base branch
from
docs/update-optional-deps
base: development
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| --- | ||
| sidebar_position: 0 | ||
| sidebar_title: Upgrade to V6 | ||
| title: Upgrade to V6 | ||
| doc-type: banner | ||
| description: Learn about the optional peer dependency migration when upgrading from Siemens Industrial Experience design system V5 to V6. | ||
| --- | ||
|
|
||
| # Upgrade to V6.0.0 | ||
|
|
||
| :::info Recommended upgrade path | ||
| We strongly recommend upgrading version by version and not skipping major versions. If your project is still on an older major release, complete each intermediate migration first before moving to Version 6. | ||
| ::: | ||
|
|
||
| ## Optional peer dependencies | ||
|
|
||
| In `@siemens/ix` V6, the following packages are declared as optional `peerDependencies`. This is an intentional breaking contract change in V6. | ||
|
|
||
| | Package | Supported version | | ||
| | :--- | :--- | | ||
| | `@floating-ui/dom` | `^1.6.13` | | ||
| | `animejs` | `^4.1.2` | | ||
| | `luxon` | `^3.4.4` | | ||
| | `@stencil/core` | `^4.43.5` | | ||
|
|
||
| ### Normal consumers | ||
|
|
||
| Standard/root distribution, the custom-elements entry point `@siemens/ix/components`, loader, hydrate, and Angular/React/Vue wrappers remain self-contained because these runtime libraries are bundled. Users of these normal entry points do not need to install these peers solely for Siemens Industrial Experience. | ||
|
|
||
| ### Stencil collection consumers | ||
|
|
||
| The published Stencil collection output, using the `collection` / `collection:main` package entries and `dist/collection`, retains bare imports for these runtime libraries. Consumers relying on this Stencil collection must explicitly install **all four packages** listed above. These packages are not optional for collection users. | ||
|
|
||
| ## Installation | ||
|
|
||
| If you rely on the Stencil collection, install all four packages with your preferred package manager: | ||
|
|
||
| ```bash | ||
| pnpm add @floating-ui/dom animejs luxon @stencil/core | ||
| ``` | ||
|
|
||
| ```bash | ||
| npm install @floating-ui/dom animejs luxon @stencil/core | ||
| ``` | ||
|
|
||
| ```bash | ||
| yarn add @floating-ui/dom animejs luxon @stencil/core | ||
| ``` | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Medium — installation commands omit a required peer dependency\n\nThe page says collection consumers must install all required packages, but this command (and the npm/Yarn equivalents below) omits the still-required
@siemens/ix-iconspeer dependency. Copying these commands—particularly with Yarn or peer auto-installation disabled—can leave collection consumers with an unresolved peer dependency and an incomplete installation. Please add@siemens/ix-iconsto all three commands, or explicitly state that it remains a required existing dependency.