docs(pds-icon): add technical notes on icon usage #596
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.
Description
This PR adds a "Technical Notes" section to the
pds-icondocumentation to clarify the intentional differences in icon usage between React and web components.Motivation: Developers may be confused about why React components use the
iconproperty while web components use thenameattribute. This documentation update explains the reasoning behind this design decision and helps developers understand the framework-specific optimizations.Changes:
pds-icon.mdxiconproperty with imported icon objects for type safety, autocomplete, and tree-shakingnameattribute with string values for HTML-like syntaxnamein React triggers a warning and has no effectNo new dependencies are required for this change.
Fixes #(issue)
Type of change
How Has This Been Tested?
Test Configuration:
Checklist: