Skip to content

Add previews for CupertinoIcons in the API docs like material Icons have #45097

Closed

Description

@DanTup

On the material icons there are previews of each icon:

https://api.flutter.dev/flutter/material/Icons-class.html

However the same is not the case for the Cupertino icons:

https://api.flutter.dev/flutter/cupertino/CupertinoIcons-class.html

I don't know if there's a technical reason for this - it'd be nice to support if possible. In VS Code we use a regex to find these icon previews for Material and swap them out with images that will work there (so you have in-editor previews), but this also fails for Cupertino. If there were previous on the page, we could probably do the same thing there (raised at Dart-Code/Dart-Code#638 (comment)).

Activity

  1. added
    p: cupertino_uicupertino_ui package in flutter/packages
    c: proposalA detailed proposal for a change to Flutter
    c: new featureNothing broken; request for a new capability
    on Nov 18, 2019
  2. added
    frameworkflutter/packages/flutter repository. See also f: labels.
    on Nov 19, 2019
  3. xster commented on Mar 31, 2020

    @xster
    Member

    There's no good reason. I just haven't made the CSS to break out all the icons into images. We should definitely do this.

  4. jmagman commented on Jun 15, 2020

    @jmagman
    Member

    A user survey response requested this, and also pointed out that the README at https://github.com/flutter/cupertino_icons doesn't have the constants.

  5. guidezpl commented on Dec 4, 2020

    @guidezpl
    Member

    @xster I'm doing some work around icons at the moment, and we have the font available now, so I could fix this issue. Are you using a script (like dev/tools/update_icons.dart) to generate cupertino's icons.dart?

  6. xster commented on Dec 4, 2020

    @xster
    Member
  7. DanTup commented on Jan 14, 2021

    @DanTup
    ContributorAuthor

    Awesome! I've added support for this to VS Code for the next version. Thanks!

    Screenshot 2021-01-14 at 12 15 20

  8. github-actions commented on Aug 7, 2021

    @github-actions

    This thread has been automatically locked since there has not been any recent activity after it was closed. If you are still experiencing a similar issue, please open a new bug, including the output of flutter doctor -v and a minimal reproduction of the issue.

  9. locked as resolved and limited conversation to collaborators on Aug 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    c: new featureNothing broken; request for a new capabilityc: proposalA detailed proposal for a change to Flutterd: api docsIssues with https://api.flutter.dev/frameworkflutter/packages/flutter repository. See also f: labels.p: cupertino_uicupertino_ui package in flutter/packages

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions