Remove unused iconClassName prop from Nav.types#4634
Merged
dzearing merged 3 commits intomicrosoft:masterfrom Apr 23, 2018
Merged
Remove unused iconClassName prop from Nav.types#4634dzearing merged 3 commits intomicrosoft:masterfrom
dzearing merged 3 commits intomicrosoft:masterfrom
Conversation
Collaborator
|
I'm thinking deprecate, and change the comment to point out it does nothing. Someone might have used it and not looked too closely and not noticed it doesn't do what it was intended to do anymore, or used it before it was removed and didn't notice - but if its removed and used in that way it will still be a breaking change that they will have to dig out and fix. Deprecate now and remove in v6 makes more sense to me. |
d3c8ce0 to
cd61afd
Compare
oengusmacinog-zz
suggested changes
Apr 20, 2018
|
|
||
| /** | ||
| * Classname to apply to the icon link. | ||
| * iconClassName has been deprecated in favor of IIconProps. Use IIconProps.className instead. |
Collaborator
There was a problem hiding this comment.
Can you change IIconProps (the Type) to iconProps (the actual prop of type IIconProps you want to use).
Nitpicky I know, but clarity is everything in the documentation.
dzearing
approved these changes
Apr 23, 2018
Markionium
added a commit
to Markionium/office-ui-fabric-react
that referenced
this pull request
Apr 26, 2018
* master: (42 commits) Applying package updates. ProgressIndicator: Finish conversion to mergeStyles (microsoft#4595) Fix props validation for Breadcrumb (microsoft#4666) No unused vars part of ts (microsoft#4670) Picker/Autofill: fixes several minor bugs. (microsoft#4569) Fix Calendar component PREV/NEXT month, year, and "Go to today" handlers firing twice (microsoft#4662) Applying package updates. Merge styles order (microsoft#4664) Fabric component: revert class change and make it backwards compatible (microsoft#4671) Addressing Issue microsoft#3707 - OverflowSet: Add the ability to set aria-label (microsoft#4667) Fix input type for Tile ARIA label prop (microsoft#4668) Fix theme slots for DetailsList header colors (microsoft#4658) Applying package updates. Jolore/calendar updates (microsoft#4643) Remove wordWrap setting. (microsoft#4657) Pivot: convert to mergeStyles - part 1 (microsoft#4656) Use the `data-is-scrollable` attribute on the correct ScrollablePane div (microsoft#4602) Applying package updates. Remove unused iconClassName prop from Nav.types (microsoft#4634) Jest snapshots: classes in animations should autoexpand. (microsoft#4647) ...
Markionium
added a commit
to Markionium/office-ui-fabric-react
that referenced
this pull request
Apr 26, 2018
* master: (34 commits) Applying package updates. ProgressIndicator: Finish conversion to mergeStyles (microsoft#4595) Fix props validation for Breadcrumb (microsoft#4666) No unused vars part of ts (microsoft#4670) Picker/Autofill: fixes several minor bugs. (microsoft#4569) Fix Calendar component PREV/NEXT month, year, and "Go to today" handlers firing twice (microsoft#4662) Applying package updates. Merge styles order (microsoft#4664) Fabric component: revert class change and make it backwards compatible (microsoft#4671) Addressing Issue microsoft#3707 - OverflowSet: Add the ability to set aria-label (microsoft#4667) Fix input type for Tile ARIA label prop (microsoft#4668) Fix theme slots for DetailsList header colors (microsoft#4658) Applying package updates. Jolore/calendar updates (microsoft#4643) Remove wordWrap setting. (microsoft#4657) Pivot: convert to mergeStyles - part 1 (microsoft#4656) Use the `data-is-scrollable` attribute on the correct ScrollablePane div (microsoft#4602) Applying package updates. Remove unused iconClassName prop from Nav.types (microsoft#4634) Jest snapshots: classes in animations should autoexpand. (microsoft#4647) ...
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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 participants
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.
Pull request checklist
$ npm run changeDescription of changes
#4581 reported that
iconClassNamedoes not apply a customclassNameto Nav button icons as the documentation says. Looking thru the changes this functionality seems to have been refactored toIIConProps. As far as I can tell this prop is unused across the lib code and can be safely removed. However, lets mark it as deprecated for now and advise usingIIconProps.classNameinherited fromReact.HTMLAttributes<HTMLElement>.Last time I can see
iconClassNamein use is: https://github.com/OfficeDev/office-ui-fabric-react/blob/5.0/packages/office-ui-fabric-react/src/components/Nav/Nav.tsx#L152Focus areas to test
Property is unused so it doesn't work now anyway. You can test that
IIConPropsworks by looking at the "Delete" nav item's icon in https://codepen.io/kevintcoughlin/pen/aGoGvm?editors=1010. Deprecated for now so should not be a breaking change for anyone.