feat!: convert enums to string unions #2962
Merged
Conversation
This file contains 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
All enums used as properties on components have been converted to string union types refactor: ViewType is now a string union type and not an enum BREAKING CHANGE: ViewType is now a string union type and not an enum refactor: UserType is now a string union type and not an enum BREAKING CHANGE: UserType is now a string union type and not an enum refactor: PersonType is now a string union type and not an enum BREAKING CHANGE: PersonType is now a string union type and not an enum refactor: GroupType is now a string union type and not an enum BREAKING CHANGE: GroupType is now a string union type and not an enum refactor: groupType property on MgtPeoplePicker is now GroupType[] BREAKING CHANGE: groupType property on MgtPeoplePicker is now a GroupType[] not a GroupType that is a bitmask of the desired group types. Developers using the group-type attribute will find the behavior unchanged. refactor: avatarType renamed to AvatarType and converted to string union type BREAKING CHANGE: the avatarType eunm has been renamed to AvatarType for consistency and converted to a string union type refactor: ResponseType for mgt-get converted to string union type from enum BREAKING CHANGE: the ResponseType for mgt-get is now a string union type and not an enum refactor: PersonCardInteraction is now a string union type and not an enum BREAKING CHANGE: PersonCardInteraction is now a string union type and not an enum
|
🚀 New react-contoso sample application deployed here |
1 similar comment
|
🚀 New react-contoso sample application deployed here |
|
📖 The updated storybook is available here |
1 similar comment
|
📖 The updated storybook is available here |
…neration in Storybook
|
🚀 New react-contoso sample application deployed here |
|
📖 The updated storybook is available here |
Signed-off-by: Martin Musale <martinmusale@microsoft.com>
musale
approved these changes
Jan 24, 2024
|
🚀 New react-contoso sample application deployed here |
|
📖 The updated storybook is available here |
Mnickii
approved these changes
Jan 24, 2024
|
This impacts directly #2934. We should wait for this to be merged before we merge the big storybook changes. |
sebastienlevert
approved these changes
Jan 24, 2024
6 tasks
|
🚀 New react-contoso sample application deployed here |
|
|
📖 The updated storybook is available here |
Thank you for catching those, I got the ones in the tests, but totally didn't think to double check the casing in the stories |
This was referenced Jun 20, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Closes #2942
PR Type
Description of the changes
rework all enum based component attribute properties as string unions for consistency between react and web components
PR checklist
yarn build) and changes have been tested in at least two supported browsers (Edge + non-Chromium based browser)yarn setLicense)Other information
There are many breaking changes in this PR for React consumers of the library, this simplifies the usage of the components
Old style:
Old style:
Thanks to the use of string unions we still get intellisense and type checking on these props, they're just simpler to use and align to the web component attributes e.g.