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

🚀 Rewrite icon package #31

Merged
merged 128 commits into from
Dec 13, 2020
Merged

🚀 Rewrite icon package #31

merged 128 commits into from
Dec 13, 2020

Conversation

mitchelloharawild
Copy link
Owner

This is a complete rewrite of the package to improve maintainability and performance. This chance will also move the repository from ropenscilabs/icon to its new home at mitchelloharawild/icon.

New icon sets

Breaking changes

  • Icons are no longer included directly in the package, and will require downloading before use.
  • Animations of icons is no longer supported (this functionality will be re-introduced as a new package).
  • The iconset_icon interface for accessing the icon icon from the iconset icon set has been replaced with iconset$icon.
  • The iconset() interface for accessing the icons is now specific to each icon library.
  • The short names (fa, ii, etc.) have been replaced with longer, more informative names (fontawesome, ionicons, etc.).

Improvements

  • Icons now use SVG files instead of font files. This substantially reduces the output file's size and allows more flexibility and integrations with other libraries in the future.
  • Icon sets can now be updated at any time without updating the package. The download_*() helpers can be used to install icon libraries.
  • Custom icon sets can be created from a folder of SVG files.
  • Icons can now be used with word_document and github_document output formats.
  • Improved detection of output format types to work with more rmarkdown extensions.

Bug fixes

  • Icons now work as expected in titles.
  • Icons now work alongside emojis.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants