search

microsoft / fluentui

Fluent UI web represents a collection of utilities, React components, and web components for building web applications.
https://react.fluentui.dev
Other
18.46k stars 2.73k forks source link

Review component APIs to ensure overall consistency #19115

Closed miroslavstastny closed 3 years ago

miroslavstastny commented 3 years ago

@ecraig12345 to potentially start the discussion

[days for audit, weeks for impl]

JustSlone commented 3 years ago

Need an owner for this item, @ecraig12345 for context and @behowell to find a driver

ecraig12345 commented 3 years ago

Potentially relevant: #19458 adds *.page.json generation for react-components (by request from @paulgildea). These files are used to power the API reference tables on the v8 doc site and might be used on the new doc site too, hence the request to add them for converged.

A variant of this processing might also be useful for generating API comparison tables, but it doesn't currently support expanding extends or unions (and I'm not sure how hard that would be to add). Our fork of react-docgen-typescript under scripts/gulp/plugins/util/docgen.ts does support those things, so getting that working against converged is probably a better path for API comparison purposes.

JustSlone commented 3 years ago

@GeoffCoxMSFT to take point on generate a list of API names for comparison

GeoffCoxMSFT commented 3 years ago

PR to add comments to is here: https://github.com/microsoft/fluentui/pull/19775

GeoffCoxMSFT commented 3 years ago

Created work items: