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

tableau-icons:0.1.0 #1651

Merged
merged 12 commits into from
Feb 4, 2025
Merged

tableau-icons:0.1.0 #1651

merged 12 commits into from
Feb 4, 2025

Conversation

joelvonrotz
Copy link
Contributor

I am submitting

  • a new package
  • an update for a package

Description: tableau-icons is a package for inserting Tabler.io icons into a document. It provides two functions, one for 'block' icons and the other for inline icons, and supports coloring and size changing. To handle the large icon count better, I've created two svg spreadsheets, which Typst filters through via regex. These can be updated easily through a python script.

While it works, a heavy stress test has not been done. The PDF document inside the docs folder is the largest stress test I've done (background of the header image has been created with this package).

  • As this is my first package, I would be grateful for some feedback.

I have read and followed the submission guidelines and, in particular, I

  • selected a name that isn't the most obvious or canonical name for what the package does
  • added a typst.toml file with all required keys
  • added a README.md with documentation for my package
  • have chosen a license and added a LICENSE file or linked one in my README.md
  • tested my package locally on my system and it worked
  • excluded PDFs or README images, if any, but not the LICENSE
  • ensured that my package is licensed such that users can use and distribute the contents of its template directory without restriction, after modifying them through normal use.

@typst-package-check typst-package-check bot changed the title added tableau-icons version 0.1.0 tableau-icons:0.1.0 Feb 1, 2025
@typst-package-check typst-package-check bot added the new A new package submission. label Feb 1, 2025
@joelvonrotz
Copy link
Contributor Author

One thing I am concerned with is the 2MB file for the outlined icons. I do not wish to "motivate" others to also create such large files and therefore would like to hear your opinion on these.

@joelvonrotz
Copy link
Contributor Author

converted the render system from regexing to using dictionary structures. While it introduces a bit larger files, it improves rendering quite a lot. On my system rendering the stress test doc (which renders all the icons) takes ~1.2s with the json variant compared to the ~13s of the regex variant.

@elegaanz
Copy link
Member

elegaanz commented Feb 3, 2025

Hello, and thank you for submitting this package. A preferable approach here would be to have the icons in a font file, and the package would only be responsible for translating human readable names to glyphs. The user of your package would have to download and install the font file by themselves, as they are not allowed in packages. Could you investigate to see if tabler.io provides an icon font, or if there are tools you could use to convert the SVG files to OTF, please?

@joelvonrotz
Copy link
Contributor Author

Thank you, so I've redid the thing and it should now work with the tabler icons font file!

@elegaanz
Copy link
Member

elegaanz commented Feb 4, 2025

Thank you :)

@elegaanz elegaanz merged commit 6b21b9b into typst:main Feb 4, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new A new package submission.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants