Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Clean up some prop comments and deprecated messages #16555

Merged
merged 5 commits into from
Jan 27, 2021
Merged

Clean up some prop comments and deprecated messages #16555

merged 5 commits into from
Jan 27, 2021

Conversation

ecraig12345
Copy link
Member

Pull request checklist

  • Include a change request file using $ yarn change

Description of changes

Assorted cleanup of component prop comments, deprecated messages, and other doc comments. (I did most of this a long time ago but never checked it in for some reason.)

@DustyTheBot
Copy link

DustyTheBot commented Jan 21, 2021 •
edited

Warnings
⚠️ There are no updates provided to CHANGELOG. Ensure there are no publicly visible changes introduced by this PR.

Generated by 🚫 dangerJS against 8ccb1e1

@codesandbox-ci
Copy link

codesandbox-ci bot commented Jan 21, 2021 •
edited

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 8ccb1e1:

Sandbox Source
Fluent UI Button Configuration
codesandbox-react-template Configuration
codesandbox-react-northstar-template Configuration

@size-auditor
Copy link

size-auditor bot commented Jan 21, 2021 •
edited

Asset size changes

Size Auditor did not detect a change in bundle size for any component!

Baseline commit: a3a5f5331ea6691af6ef0197742247a9bc2e7859 (build)

@fabricteam
Copy link
Collaborator

fabricteam commented Jan 21, 2021 •
edited

Perf Analysis

No significant results to display.

All results

Scenario Render type Master Ticks PR Ticks Iterations Status
Avatar mount 884 889 5000
BaseButtonCompat mount 959 966 5000
Breadcrumb mount 44262 42969 5000
Checkbox mount 1666 1689 5000
CheckboxBase mount 1456 1444 5000
ChoiceGroup mount 5238 5217 5000
ComboBox mount 1024 1113 1000
CommandBar mount 11076 11201 1000
ContextualMenu mount 6152 6548 1000
DefaultButtonCompat mount 1175 1261 5000
DetailsRow mount 3883 3915 5000
DetailsRowFast mount 3810 3824 5000
DetailsRowNoStyles mount 3627 3599 5000
Dialog mount 1529 1562 1000
DocumentCardTitle mount 1797 1797 1000
Dropdown mount 3486 3435 5000
FocusTrapZone mount 1823 1821 5000
FocusZone mount 1877 1841 5000
IconButtonCompat mount 1898 1947 5000
Label mount 346 368 5000
Layer mount 1842 1878 5000
Link mount 481 482 5000
MakeStyles mount 2046 2063 50000
MenuButtonCompat mount 1585 1599 5000
MessageBar mount 2093 2142 5000
Nav mount 3493 3514 1000
OverflowSet mount 1108 1088 5000
Panel mount 1572 1649 1000
Persona mount 899 966 1000
Pivot mount 1495 1489 1000
PrimaryButtonCompat mount 1409 1351 5000
Rating mount 8296 8266 5000
SearchBox mount 1434 1391 5000
Shimmer mount 2945 2808 5000
Slider mount 2072 2040 5000
SpinButton mount 5566 5475 5000
Spinner mount 428 438 5000
SplitButtonCompat mount 3266 3298 5000
Stack mount 530 518 5000
StackWithIntrinsicChildren mount 1557 1533 5000
StackWithTextChildren mount 4821 4734 5000
SwatchColorPicker mount 10378 10559 5000
Tabs mount 1496 1455 1000
TagPicker mount 2989 2918 5000
TeachingBubble mount 12440 12108 5000
Text mount 450 466 5000
TextField mount 1455 1437 5000
ThemeProvider mount 2175 2193 5000
ThemeProvider virtual-rerender 643 641 5000
Toggle mount 867 820 5000
button mount 717 738 5000
buttonNative mount 111 110 5000

Perf Analysis (Fluent)

⚠️ 1 potential perf regressions detected

Potential regressions comparing to master

Scenario Current PR Ticks Baseline Ticks Ratio Regression Analysis
ButtonMinimalPerf.default 214 234 0.91:1 analysis
Perf comparison
Status Scenario Fluent TPI Fabric TPI Ratio Iterations Ticks
🦄 Avatar.Fluent 0.19 0.53 0.36:1 2000 386
🦄 Button.Fluent 0.13 0.22 0.59:1 5000 664
🔧 Checkbox.Fluent 0.68 0.38 1.79:1 1000 678
🎯 Dialog.Fluent 0.17 0.24 0.71:1 5000 873
🔧 Dropdown.Fluent 3.11 0.42 7.4:1 1000 3108
🔧 Icon.Fluent 0.15 0.06 2.5:1 5000 766
🦄 Image.Fluent 0.09 0.13 0.69:1 5000 460
🔧 Slider.Fluent 1.64 0.47 3.49:1 1000 1635
🔧 Text.Fluent 0.08 0.03 2.67:1 5000 404
🦄 Tooltip.Fluent 0.12 0.92 0.13:1 5000 613

🔧 Needs work     🎯 On target     🦄 Amazing

Perf tests with no regressions
Scenario Current PR Ticks Baseline Ticks Ratio
LayoutMinimalPerf.default 525 462 1.14:1
ImageMinimalPerf.default 514 461 1.11:1
CarouselMinimalPerf.default 593 538 1.1:1
ChatMinimalPerf.default 771 712 1.08:1
DatepickerMinimalPerf.default 55317 51297 1.08:1
DividerMinimalPerf.default 481 444 1.08:1
GridMinimalPerf.default 444 410 1.08:1
FlexMinimalPerf.default 368 343 1.07:1
ListWith60ListItems.default 761 710 1.07:1
ChatDuplicateMessagesPerf.default 448 421 1.06:1
TreeWith60ListItems.default 195 184 1.06:1
Button.Fluent 664 629 1.06:1
AvatarMinimalPerf.default 246 235 1.05:1
ButtonUseCssPerf.default 997 952 1.05:1
DropdownManyItemsPerf.default 886 846 1.05:1
ListMinimalPerf.default 606 579 1.05:1
TextMinimalPerf.default 431 411 1.05:1
Icon.Fluent 766 729 1.05:1
CheckboxMinimalPerf.default 3243 3125 1.04:1
RefMinimalPerf.default 263 253 1.04:1
SkeletonMinimalPerf.default 456 439 1.04:1
VideoMinimalPerf.default 726 698 1.04:1
Image.Fluent 460 442 1.04:1
AttachmentSlotsPerf.default 1385 1347 1.03:1
ButtonSlotsPerf.default 722 701 1.03:1
FormMinimalPerf.default 536 518 1.03:1
SplitButtonMinimalPerf.default 4229 4101 1.03:1
IconMinimalPerf.default 778 753 1.03:1
TableMinimalPerf.default 488 474 1.03:1
TextAreaMinimalPerf.default 571 552 1.03:1
ToolbarMinimalPerf.default 1061 1031 1.03:1
TooltipMinimalPerf.default 866 844 1.03:1
Avatar.Fluent 386 376 1.03:1
Tooltip.Fluent 613 597 1.03:1
AlertMinimalPerf.default 353 345 1.02:1
ButtonOverridesMissPerf.default 1982 1946 1.02:1
CardMinimalPerf.default 695 682 1.02:1
DialogMinimalPerf.default 938 924 1.02:1
HeaderSlotsPerf.default 942 922 1.02:1
LoaderMinimalPerf.default 816 797 1.02:1
MenuMinimalPerf.default 1033 1010 1.02:1
MenuButtonMinimalPerf.default 1837 1797 1.02:1
PortalMinimalPerf.default 179 176 1.02:1
TreeMinimalPerf.default 891 873 1.02:1
AnimationMinimalPerf.default 475 471 1.01:1
LabelMinimalPerf.default 500 497 1.01:1
ListCommonPerf.default 794 783 1.01:1
ReactionMinimalPerf.default 490 486 1.01:1
TableManyItemsPerf.default 2285 2270 1.01:1
CustomToolbarPrototype.default 3815 3761 1.01:1
Dialog.Fluent 873 863 1.01:1
Slider.Fluent 1635 1625 1.01:1
BoxMinimalPerf.default 423 421 1:1
ButtonUseCssNestingPerf.default 1249 1250 1:1
HeaderMinimalPerf.default 455 454 1:1
InputMinimalPerf.default 1455 1448 1:1
ItemLayoutMinimalPerf.default 1415 1414 1:1
ListNestedPerf.default 667 668 1:1
PopupMinimalPerf.default 797 796 1:1
ProviderMergeThemesPerf.default 1761 1766 1:1
Text.Fluent 404 403 1:1
AccordionMinimalPerf.default 191 193 0.99:1
DropdownMinimalPerf.default 3315 3350 0.99:1
RadioGroupMinimalPerf.default 544 547 0.99:1
Dropdown.Fluent 3108 3155 0.99:1
EmbedMinimalPerf.default 4533 4603 0.98:1
SliderMinimalPerf.default 1700 1735 0.98:1
ChatWithPopoverPerf.default 521 545 0.96:1
SegmentMinimalPerf.default 426 443 0.96:1
Checkbox.Fluent 678 709 0.96:1
AttachmentMinimalPerf.default 190 199 0.95:1
RosterPerf.default 1304 1367 0.95:1
ProviderMinimalPerf.default 1061 1122 0.95:1
StatusMinimalPerf.default 822 861 0.95:1

behowell
behowell approved these changes Jan 21, 2021
View reviewed changes
Copy link
Contributor

@behowell behowell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 for react-tabs changes

khmakoto
khmakoto reviewed Jan 22, 2021
View reviewed changes
packages/react-file-type-icons/src/getFileTypeIconProps.ts
*/
size?: FileTypeIconSize;
/**
* The type of image file to use. Can be svg or png.
* Defaults to svg.
* @default 'svg'
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see we use default, defaultvalue and defaultValue across the repo.

Probably outside the scope of this PR, but we should make all of them consistent.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed, both on consistency and being out of scope for now

packages/react-focus/src/components/FocusZone/FocusZone.types.ts Show resolved Hide resolved
packages/react-internal/src/compat/components/Button/Button.types.ts Show resolved Hide resolved
packages/react-internal/src/compat/components/Button/Button.types.ts Show resolved Hide resolved
packages/react-internal/src/compat/components/Button/Button.types.ts Show resolved Hide resolved
@ecraig12345 ecraig12345 merged commit 2e22b74 into microsoft:master Jan 27, 2021
@ecraig12345 ecraig12345 deleted the comment-fixes-1 branch January 27, 2021 23:56
@msft-fluent-ui-bot
Copy link
Collaborator

🎉@fluentui/scheme-utilities@v8.0.0-beta.13 has been released which incorporates this pull request.:tada:

Handy links:

@msft-fluent-ui-bot
Copy link
Collaborator

🎉@fluentui/style-utilities@v8.0.0-beta.13 has been released which incorporates this pull request.:tada:

Handy links:

@msft-fluent-ui-bot
Copy link
Collaborator

🎉@fluentui/react@v8.0.0-beta.44 has been released which incorporates this pull request.:tada:

Handy links:

@msft-fluent-ui-bot
Copy link
Collaborator

🎉@fluentui/react-toggle@v1.0.0-beta.36 has been released which incorporates this pull request.:tada:

Handy links:

@msft-fluent-ui-bot
Copy link
Collaborator

🎉@fluentui/react-focus@v8.0.0-beta.16 has been released which incorporates this pull request.:tada:

Handy links:

@msft-fluent-ui-bot
Copy link
Collaborator

🎉@fluentui/react-file-type-icons@v8.0.0-beta.15 has been released which incorporates this pull request.:tada:

Handy links:

@msft-fluent-ui-bot
Copy link
Collaborator

🎉@fluentui/react-tabs@v1.0.0-beta.37 has been released which incorporates this pull request.:tada:

Handy links:

@msft-fluent-ui-bot
Copy link
Collaborator

🎉@fluentui/react-slider@v1.0.0-beta.36 has been released which incorporates this pull request.:tada:

Handy links:

@msft-fluent-ui-bot
Copy link
Collaborator

🎉@fluentui/font-icons-mdl2@v8.0.0-beta.13 has been released which incorporates this pull request.:tada:

Handy links:

@msft-fluent-ui-bot
Copy link
Collaborator

🎉@fluentui/date-time-utilities@v8.0.0-beta.2 has been released which incorporates this pull request.:tada:

Handy links:

@msft-fluent-ui-bot
Copy link
Collaborator

🎉@fluentui/react-experiments@v8.0.0-beta.47 has been released which incorporates this pull request.:tada:

Handy links:

@msft-fluent-ui-bot
Copy link
Collaborator

🎉@fluentui/react-date-time@v8.0.0-beta.36 has been released which incorporates this pull request.:tada:

Handy links:

@msft-fluent-ui-bot
Copy link
Collaborator

🎉@fluentui/react-checkbox@v1.0.0-beta.37 has been released which incorporates this pull request.:tada:

Handy links:

@msft-fluent-ui-bot
Copy link
Collaborator

🎉@fluentui/react-internal@v8.0.0-beta.38 has been released which incorporates this pull request.:tada:

Handy links:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@khmakoto khmakoto khmakoto approved these changes

@layershifter layershifter layershifter approved these changes

@behowell behowell behowell approved these changes

@aditima aditima Awaiting requested review from aditima

@assuncaocharles assuncaocharles Awaiting requested review from assuncaocharles

@bigbadcapers bigbadcapers Awaiting requested review from bigbadcapers bigbadcapers is a code owner

@dzearing dzearing Awaiting requested review from dzearing dzearing is a code owner

@evlevy evlevy Awaiting requested review from evlevy

@Jahnp Jahnp Awaiting requested review from Jahnp Jahnp is a code owner

@joschect joschect Awaiting requested review from joschect

@jurokapsiar jurokapsiar Awaiting requested review from jurokapsiar

@leddie24 leddie24 Awaiting requested review from leddie24

@ling1726 ling1726 Awaiting requested review from ling1726

@lorejoh12 lorejoh12 Awaiting requested review from lorejoh12

@Markionium Markionium Awaiting requested review from Markionium

@micahgodbolt micahgodbolt Awaiting requested review from micahgodbolt

@miroslavstastny miroslavstastny Awaiting requested review from miroslavstastny

@mtennoe mtennoe Awaiting requested review from mtennoe

@phkuo phkuo Awaiting requested review from phkuo phkuo is a code owner

@pompomon pompomon Awaiting requested review from pompomon

@ThomasMichon ThomasMichon Awaiting requested review from ThomasMichon ThomasMichon is a code owner

@Vitalius1 Vitalius1 Awaiting requested review from Vitalius1

@xugao xugao Awaiting requested review from xugao

@yiminwu yiminwu Awaiting requested review from yiminwu

Assignees

@layershifter layershifter

Labels
Area: Documentation PR: API Modified
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
7 participants
@ecraig12345 @DustyTheBot @fabricteam @msft-fluent-ui-bot @khmakoto @layershifter @behowell