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.

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

Clarify ButtonThemeData usage and documentation #98691

Open
Piinks opened this issue Feb 17, 2022 · 2 comments
Open

Clarify ButtonThemeData usage and documentation #98691

Piinks opened this issue Feb 17, 2022 · 2 comments
Labels
a: annoyance Repeatedly frustrating issues with non-experimental functionality a: quality A truly polished experience d: api docs Issues with https://api.flutter.dev/ f: material design flutter/packages/flutter/material repository. framework flutter/packages/flutter repository. See also f: labels. P2 Important issues not at the top of the work list team-design Owned by Design Languages team triaged-design Triaged by Design Languages team
Projects

Comments

@Piinks
Copy link
Contributor

Piinks commented Feb 17, 2022

Feedback from @rydmike in #98537 (comment)

ButtonThemeData

The ButtonThemeData class is marked as obsolete in the docs, but not as deprecated.

In its theme ButtonTheme:

/// ### This class is obsolete.

And in its theme data ButtonThemeData:

/// ### This class is obsolete.

In addition to the buttons that will be removed [FlatButton, OutlineButton, RaisedButton], the theme and theme data is used by the buttons' parent class MaterialButton and the ButtonBar and its theme ButtonBarTheme, plus as far I could notice DropdownButton uses one property from it as well.

Instead of having the docs above mention that it is used by buttons that will no longer exist, maybe consider updating the doc comment and instead mention the usage by ButtonBar, DropdownButton and MaterialButton, if it will remain. It kind of will have to, but more on that below.

Perhaps for the update also consider updating the doc comment for the buttonTheme property in ThemeData to better reflects its remaining usage in ButtonBar, DropdownButton and MaterialButton

Some of these doc updates will be completed in the course of resolving #98537

/// Defines the default configuration of button widgets, like [RaisedButton]


In general, I think the current use case is unclear to users, obsolete is not deprecated, but it's not really obsolete either if other parts of the framework still use ButtonThemeData. There is definitely some opportunity for better clarity and guidance here - even if that is just to say we plan to make more changes in the future that will eventually remove this class.

cc @HansMuller @darrenaustin

@Piinks Piinks added framework flutter/packages/flutter repository. See also f: labels. f: material design flutter/packages/flutter/material repository. d: api docs Issues with https://api.flutter.dev/ a: quality A truly polished experience documentation a: annoyance Repeatedly frustrating issues with non-experimental functionality labels Feb 17, 2022
@Piinks Piinks added the P2 Important issues not at the top of the work list label Feb 17, 2022
@Piinks
Copy link
Contributor Author

Piinks commented Feb 17, 2022

If this is planned to be removed eventually, see full linked comment above, just that would be a beneficial bit of guidance.

@TahaTesser TahaTesser added this to To do in Nevercode via automation Feb 18, 2022
@TahaTesser TahaTesser self-assigned this Feb 18, 2022
@Piinks
Copy link
Contributor Author

Piinks commented Feb 24, 2022

Confirmed with @HansMuller yesterday, this should be deprecated

@TahaTesser TahaTesser removed their assignment Oct 3, 2022
@flutter-triage-bot flutter-triage-bot bot added multiteam-retriage-candidate team-design Owned by Design Languages team triaged-design Triaged by Design Languages team labels Jul 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a: annoyance Repeatedly frustrating issues with non-experimental functionality a: quality A truly polished experience d: api docs Issues with https://api.flutter.dev/ f: material design flutter/packages/flutter/material repository. framework flutter/packages/flutter repository. See also f: labels. P2 Important issues not at the top of the work list team-design Owned by Design Languages team triaged-design Triaged by Design Languages team
Projects
No open projects
Nevercode
  
To do
Development

Successfully merging a pull request may close this issue.

3 participants