Skip to content

chore(react-card): add basic API documentation#23410

Merged
theerebuss merged 4 commits into
microsoft:masterfrom
theerebuss:card-documentation
Jun 6, 2022
Merged

chore(react-card): add basic API documentation#23410
theerebuss merged 4 commits into
microsoft:masterfrom
theerebuss:card-documentation

Conversation

@theerebuss

Copy link
Copy Markdown
Contributor

Current Behavior

There was little documentation on the exported Card content.

New Behavior

Added basic documentation for all of the undocumented API.

Related Issue(s)

#19336

@fabricteam

fabricteam commented Jun 6, 2022

Copy link
Copy Markdown
Collaborator

📊 Bundle size report

Package & Exports Baseline (minified/GZIP) PR Change
react-components
react-components: Accordion, Button, FluentProvider, Image, Menu, Popover
184.567 kB
51.105 kB
184.781 kB
51.176 kB
214 B
71 B
Unchanged fixtures
Package & Exports Size (minified/GZIP)
react-card
Card - All
63.222 kB
17.946 kB
react-card
Card
58.378 kB
16.819 kB
react-card
CardFooter
7.737 kB
3.264 kB
react-card
CardHeader
9.302 kB
3.779 kB
react-card
CardPreview
7.838 kB
3.316 kB
react-components
react-components: FluentProvider & webLightTheme
33.988 kB
11.108 kB
🤖 This report was generated against 8c0f647c2e890d032e6d14183ecacddccbb8e9aa

@codesandbox-ci

codesandbox-ci Bot commented Jun 6, 2022

Copy link
Copy Markdown

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 2869bc0:

Sandbox Source
@fluentui/react 8 starter Configuration
@fluentui/react-components 9 starter Configuration

@fabricteam

Copy link
Copy Markdown
Collaborator

Perf Analysis (@fluentui/react-components)

No significant results to display.

All results

Scenario Render type Master Ticks PR Ticks Iterations Status
Avatar mount 1109 1096 5000
Button mount 661 685 5000
FluentProvider mount 2313 2292 5000
FluentProviderWithTheme mount 352 332 10
FluentProviderWithTheme virtual-rerender 291 258 10
FluentProviderWithTheme virtual-rerender-with-unmount 384 364 10
MakeStyles mount 1917 1917 50000

@size-auditor

size-auditor Bot commented Jun 6, 2022

Copy link
Copy Markdown

Asset size changes

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

Baseline commit: bad6ad63ff7e2287519e7117f8a1963b623ae18e (build)

@theerebuss theerebuss mentioned this pull request Jun 6, 2022
37 tasks

@Hotell Hotell left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

great job!

import type { SlotClassNames } from '@fluentui/react-utilities';

/**
* Static CSS class names used internally for the component slots.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

tip: you can mark it @internal . after we implement internal public API removals this will "just work"

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I think this is one of the cases where we do want to export this to prevent users who need to apply styles to the static class names from depending on a hardcoded class name.

@theerebuss theerebuss merged commit 0a35ab4 into microsoft:master Jun 6, 2022
@theerebuss theerebuss deleted the card-documentation branch June 6, 2022 15:23
marwan38 pushed a commit to marwan38/fluentui that referenced this pull request Jun 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants