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

ComboBox, Dropdown, TextField doc updates #15100

Merged
merged 8 commits into from
Sep 17, 2020
Merged

ComboBox, Dropdown, TextField doc updates #15100

merged 8 commits into from
Sep 17, 2020

Conversation

ecraig12345
Copy link
Member

@ecraig12345 ecraig12345 commented Sep 17, 2020 •
edited
Loading

Fix minor issues with some docs. (courtesy of @jennbost)

jennbost and others added 8 commits July 30, 2020 09:07
@jennbost
Replaced "drop-down menu" with "dropdown"
a8fbace 
We're deviating from the Microsoft Writing Style Guide guidance (hyphenating drop-down), because compounded (dropdown) style is more commonly seen across other industry-leading design systems.
@jennbost
Added explanation of when to use a dropdown
2e593db
@jennbost
Removed "list" from "dropdown list" references
e71f305
@jennbost
Removed erroneous guidance about form fields
568fc43 
Somehow guidance got checked in that doesn't map to our best practices. Correcting that, so we ensure everyone standardizes on the uses of asterisks for denoting required fields. And added a reminder note about ARIA properties to remind folks to consider the screenreader experience.
@ecraig12345
Merge branch 'master' into docs-update-2
b476455 
# Conflicts:
#	packages/office-ui-fabric-react/src/components/TextField/docs/TextFieldBestPractices.md
@ecraig12345
Fix aria-required guidance
ba47730
@ecraig12345
Change files
526d0b8
@ecraig12345
updates
0367d7f
@codesandbox-ci
Copy link

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 0367d7f:

Sandbox Source
Fluent UI Button Configuration
microsoft/fluentui: codesandbox-react-template Configuration
microsoft/fluentui: codesandbox-react-next-template Configuration
microsoft/fluentui: codesandbox-react-northstar-template Configuration

@xugao xugao merged commit 0b56e47 into master Sep 17, 2020
@msft-github-bot
Copy link
Contributor

Perf Analysis

No significant results to display.

All results

Scenario Render type Master Ticks PR Ticks Iterations Status
BaseButton mount 988 1001 5000
Breadcrumb mount 40340 40558 5000
BreadcrumbNext mount 154512 154103 5000
ButtonNext mount 584 593 5000
Checkbox mount 1637 1656 5000
CheckboxBase mount 1342 1393 5000
CheckboxNext mount 1576 1578 5000
ChoiceGroup mount 5210 5185 5000
ChoiceGroupNext mount 5162 5222 5000
ComboBox mount 961 918 1000
CommandBar mount 7525 7728 1000
ContextualMenu mount 12478 12579 1000
DefaultButton mount 1125 1147 5000
DetailsRow mount 3685 3682 5000
DetailsRowFast mount 3640 3749 5000
DetailsRowNoStyles mount 3418 3438 5000
Dialog mount 1519 1530 1000
DocumentCardTitle mount 1807 1792 1000
Dropdown mount 2704 2657 5000
FocusZone mount 1795 1818 5000
IconButton mount 1778 1819 5000
Label mount 350 342 5000
Link mount 488 455 5000
LinkNext mount 468 465 5000
MenuButton mount 1520 1549 5000
MessageBar mount 2072 2099 5000
MessageBarNext mount 2040 2050 5000
Nav mount 3317 3275 1000
OverflowSet mount 1393 1485 5000
OverflowSetNext mount 1060 1065 5000
Panel mount 1457 1448 1000
Persona mount 868 845 1000
Pivot mount 1435 1455 1000
PivotNext mount 1455 1454 1000
PrimaryButton mount 1308 1296 5000
Rating mount 7972 7905 5000
RatingNext mount 7868 7938 5000
SearchBox mount 1332 1360 5000
SearchBoxNext mount 1430 1387 5000
Shimmer mount 2739 2857 5000
ShimmerNext mount 2705 2633 5000
Slider mount 1505 1522 5000
SliderNext mount 2013 1938 5000
SpinButton mount 5195 5110 5000
SpinButtonNext mount 5211 5198 5000
Spinner mount 453 418 5000
SplitButton mount 3227 3246 5000
Stack mount 542 543 5000
StackWithIntrinsicChildren mount 1972 1983 5000
StackWithTextChildren mount 5205 5233 5000
SwatchColorPicker mount 10565 10667 5000
SwatchColorPickerNext mount 10464 10568 5000
TagPicker mount 2851 2846 5000
TeachingBubble mount 49119 49197 5000
TeachingBubbleNext mount 49072 49142 5000
Text mount 448 447 5000
TextField mount 1414 1417 5000
ThemeProvider mount 4939 4953 5000
ThemeProvider virtual-rerender 608 599 5000
Toggle mount 865 858 5000
ToggleNext mount 820 816 5000
button mount 110 124 5000

Perf Analysis (Fluent)

⚠️ 5 potential perf regressions detected

Potential regressions comparing to master

Scenario Current PR Ticks Baseline Ticks Ratio Regression Analysis
ButtonOverridesMissPerf.default 1730 45 38.44:1 analysis
ButtonUseCssNestingPerf.default 1135 43 26.4:1 analysis
ButtonUseCssPerf.default 888 44 20.18:1 analysis
ChatWithPopoverPerf.default 492 496 0.99:1 analysis
ListNestedPerf.default 635 937 0.68:1 analysis
Perf comparison
Status Scenario Fluent TPI Fabric TPI Ratio Iterations Ticks
🎯 Avatar.Fluent 0.49 0.51 0.96:1 2000 972
🦄 Button.Fluent 0.13 0.21 0.62:1 5000 655
🔧 Checkbox.Fluent 0.68 0.37 1.84:1 1000 675
🎯 Dialog.Fluent 0.17 0.22 0.77:1 5000 859
🔧 Dropdown.Fluent 2.99 0.5 5.98:1 1000 2993
🔧 Icon.Fluent 0.16 0.06 2.67:1 5000 791
🎯 Image.Fluent 0.09 0.12 0.75:1 5000 454
🔧 Slider.Fluent 1.59 0.37 4.3:1 1000 1589
🔧 Text.Fluent 0.08 0.03 2.67:1 5000 405
🦄 Tooltip.Fluent 0.12 15.47 0.01:1 5000 593

🔧 Needs work     🎯 On target     🦄 Amazing

Perf tests with no regressions
Scenario Current PR Ticks Baseline Ticks Ratio
PortalMinimalPerf.default 177 113 1.57:1
FlexMinimalPerf.default 374 280 1.34:1
AttachmentMinimalPerf.default 196 150 1.31:1
RefMinimalPerf.default 246 192 1.28:1
ImageMinimalPerf.default 466 374 1.25:1
DividerMinimalPerf.default 446 361 1.24:1
BoxMinimalPerf.default 412 344 1.2:1
SegmentMinimalPerf.default 412 346 1.19:1
Image.Fluent 454 388 1.17:1
Tooltip.Fluent 593 507 1.17:1
LayoutMinimalPerf.default 470 404 1.16:1
Button.Fluent 655 567 1.16:1
LabelMinimalPerf.default 469 407 1.15:1
StatusMinimalPerf.default 785 684 1.15:1
TableMinimalPerf.default 471 411 1.15:1
ChatMinimalPerf.default 695 611 1.14:1
HeaderMinimalPerf.default 463 406 1.14:1
VideoMinimalPerf.default 732 643 1.14:1
Text.Fluent 405 355 1.14:1
GridMinimalPerf.default 393 347 1.13:1
RadioGroupMinimalPerf.default 481 427 1.13:1
FormMinimalPerf.default 490 439 1.12:1
ReactionMinimalPerf.default 462 411 1.12:1
IconMinimalPerf.default 785 701 1.12:1
TextMinimalPerf.default 396 356 1.11:1
ToolbarMinimalPerf.default 1046 939 1.11:1
ProviderMergeThemesPerf.default 2013 1823 1.1:1
SkeletonMinimalPerf.default 477 433 1.1:1
Dialog.Fluent 859 780 1.1:1
Icon.Fluent 791 719 1.1:1
DialogMinimalPerf.default 856 785 1.09:1
ListMinimalPerf.default 529 487 1.09:1
ProviderMinimalPerf.default 1000 914 1.09:1
HeaderSlotsPerf.default 878 815 1.08:1
PopupMinimalPerf.default 726 675 1.08:1
AccordionMinimalPerf.default 171 160 1.07:1
AnimationMinimalPerf.default 435 408 1.07:1
CardMinimalPerf.default 632 590 1.07:1
MenuMinimalPerf.default 944 881 1.07:1
MenuButtonMinimalPerf.default 1700 1595 1.07:1
TooltipMinimalPerf.default 849 794 1.07:1
Avatar.Fluent 972 912 1.07:1
TableManyItemsPerf.default 2442 2302 1.06:1
TextAreaMinimalPerf.default 546 514 1.06:1
Checkbox.Fluent 675 637 1.06:1
AlertMinimalPerf.default 345 330 1.05:1
LoaderMinimalPerf.default 788 752 1.05:1
ButtonSlotsPerf.default 644 622 1.04:1
EmbedMinimalPerf.default 2031 1962 1.04:1
ItemLayoutMinimalPerf.default 1362 1315 1.04:1
CustomToolbarPrototype.default 3856 3695 1.04:1
TreeWith60ListItems.default 240 231 1.04:1
ButtonMinimalPerf.default 198 192 1.03:1
ChatDuplicateMessagesPerf.default 441 429 1.03:1
CheckboxMinimalPerf.default 2954 2863 1.03:1
SplitButtonMinimalPerf.default 3984 3859 1.03:1
TreeMinimalPerf.default 935 905 1.03:1
AvatarMinimalPerf.default 504 496 1.02:1
AttachmentSlotsPerf.default 1227 1210 1.01:1
DropdownManyItemsPerf.default 794 790 1.01:1
InputMinimalPerf.default 1356 1339 1.01:1
Dropdown.Fluent 2993 2951 1.01:1
CarouselMinimalPerf.default 486 488 1:1
DropdownMinimalPerf.default 2905 2942 0.99:1
SliderMinimalPerf.default 1593 1608 0.99:1
Slider.Fluent 1589 1625 0.98:1
ListWith60ListItems.default 1002 1154 0.87:1
ListCommonPerf.default 770 1033 0.75:1

@size-auditor
Copy link

size-auditor bot commented Sep 17, 2020

Asset size changes

⚠️ Insufficient baseline data to detect size changes

Unable to find bundle size details for Baseline commit: 0b435f9

Possible causes

  • The baseline build 0b435f9 is broken
  • The Size Auditor run for the baseline build 0b435f9 was not triggered

Recommendations

  • Please merge your branch for this Pull request with the latest master build and commit your changes once again

@msft-github-bot
Copy link
Contributor

🎉[email protected] has been released which incorporates this pull request.:tada:

Handy links:

@ecraig12345 ecraig12345 deleted the docs-update-2 branch September 18, 2020 17:48
@ecraig12345 ecraig12345 mentioned this pull request Sep 18, 2020
Merged
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@xugao xugao xugao approved these changes

@joschect joschect Awaiting requested review from joschect

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@ecraig12345 @msft-github-bot @xugao @jennbost