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

Adding an Icon to the Snap codebase #1201

Open
mario-christopher opened this issue Mar 8, 2024 · 0 comments
Open

Adding an Icon to the Snap codebase #1201

mario-christopher opened this issue Mar 8, 2024 · 0 comments
Assignees
Labels
snaps Related to Snaps content. tech-writing Requires updates to documentation content.

Comments

@mario-christopher
Copy link

The current version of the Snap Template does not have an Icon as part of the generated mono-repo.
Earlier, an Icon was included as part of the code base, and the builder was aware of this icon. Further, it was easier for them to replace the Icon with their product icon as it was just a replacement of an existing resource.

However, now, with removal of the Icon from the generated mono-repo, the builder no longer knows where they should put an Icon and how to do it. The bright side of this though is that we don't have issues with builders not updating the default icon, and shipping their Snap with the default Icon.

In any case, the builder needs to be aware of how to add an Icon to the Snap Project.
The foll. are some guidelines for documenting this:

  • Full spec for the Icon dimensions
  • The Icon should be shown properly in Light/Dark themes as chosen by the end-user
  • The location of the Icon file in the project.
  • The files that need to have a reference of the Icon file.
  • An error emitted by the CLI if the icon file is not included (This exists today)
  • The above error should contain a link leading the builder to the new Document outlining the Icon instructions.
@alexandratran alexandratran added snaps Related to Snaps content. tech-writing Requires updates to documentation content. labels Mar 8, 2024
@Montoya Montoya self-assigned this Mar 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
snaps Related to Snaps content. tech-writing Requires updates to documentation content.
Projects
None yet
Development

No branches or pull requests

3 participants