Skip to content

Deprecate describeEnum. #8571

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

Merged
merged 5 commits into from
Apr 25, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 81 additions & 0 deletions src/release/breaking-changes/describeEnum.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
---
title: Migration guide for describeEnum
description: Removal of describeEnum and how to migrate
---

## Summary

The global method `describeEnum` has been deprecated. Existing uses
of `describeEnum(Enum.something)` should use
`Enum.something.name` instead.

## Context

Dart 2.17 introduced enhanced enums. With them, Enum became a type
and all enums got a `name` getter, which made `describeEnum` redundant.

The `describeEnum` method was used to convert an enum value to a string,
since `Enum.something.toString()` would produce `Enum.something` instead
of `something`, which a lot of users wanted. Now, the `name` getter does this.

## Description of change

Remove `describeEnum`.

- Replace `describeEnum(Enum.something)` with `Enum.something.name`.

## Migration guide

If you used `describeEnum(Enum.field)` to acesss the string value from an
enum, you can now call `Enum.field.name`.

Code before migration:

<!-- skip -->
```dart
enum MyEnum { paper, rock }

print(describeEnum(MyEnum.paper)); // output: paper
```

Code after migration:

<!-- skip -->
```dart
enum MyEnum { paper, rock }

print(MyEnum.paper.name); // output: paper
```

## Timeline

Landed in version: TBD<br>
In stable release: not yet

## References

{% include docs/master-api.md %}

API documentation:

* [`describeEnum` stable][]
* [`describeEnum` main][]

Relevant issues:

* [☂️ Cleanup SemanticsFlag and SemanticsAction issue][]

Relevant PRs:

* [Deprecate `describeEnum` PR][]

<!-- Stable channel link: -->
[`describeEnum` stable]: {{site.api}}/flutter/lib/src/foundation/describeEnum.html

<!-- Master channel link: -->
{% include docs/master-api.md %}

[`describeEnum` main]: {{site.master-api}}/flutter/lib/src/foundation/describeEnum.html

[☂️ Cleanup SemanticsFlag and SemanticsAction issue]: {{site.repo.flutter}}/issues/123346
[Deprecate `describeEnum` PR]: {{site.repo.flutter}}/pull/125016
1 change: 1 addition & 0 deletions src/release/breaking-changes/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ release, and listed in alphabetical order:
[Removed `ignoringSemantics`]: {{site.url}}/release/breaking-changes/ignoringsemantics-migration
[The window singleton is deprecated]: {{site.url}}/release/breaking-changes/window-singleton
[Migration guide for `RouteInformation.location`]: {{site.url}}/release/breaking-changes/route-information-uri
[Migration guide for `describeEnum`]: {{site.url}}/release/breaking-changes/describeEnum
[At least one clipboard data variant must be provided]: {{site.url}}/release/breaking-changes/clipboard-data-required

### Released in Flutter 3.7
Expand Down