Welcome to TkinterWeb!
======================

.. image:: https://static.pepy.tech/badge/tkinterweb/month
    :target: https://pepy.tech/project/tkinterweb
    :alt: PyPi Downloads

.. image:: https://img.shields.io/pypi/l/tkinterweb
    :target: https://pypi.org/project/tkinterweb/
    :alt: MIT Licence

.. image:: https://img.shields.io/pypi/pyversions/tkinterweb
    :target: https://pypi.org/project/tkinterweb/
    :alt: Python 3

.. image:: https://img.shields.io/badge/%F0%9F%87%A8%F0%9F%87%A6%20made%20in%20Canada-grey
    :target: https://pypi.org/project/tkinterweb/
    :alt: Made in Canada


**TkinterWeb** is a Python library that adds HTML and CSS rendering capabilities to Tkinter widgets.

Common use cases include displaying help files, documentation, and other HTML content, rendering images (including SVG), building rich-text editors, designing apps with HTML templates, and creating more modern-looking interfaces, with advanced styling and even round buttons!

Getting started
---------------

TkinterWeb provides a `frame widget <./api/htmlframe.html>`_, a `label widget <./api/htmlframe.html#tkinterweb.HtmlLabel>`_, and a `text widget <./api/htmlframe.html#tkinterweb.HtmlText>`_. 

Check out the :doc:`usage` section to learn how to get started and discover tips and tricks, :doc:`faq` for frequently asked questions, and the :doc:`api` to explore all of the widgets and functions at your disposal!

Love this project?
------------------

You can help this project by submitting a `bug report <https://github.com/Andereoo/TkinterWeb/issues/new>`_ to report bugs or suggest new features, or by submitting a `pull request <https://github.com/Andereoo/TkinterWeb/pulls>`_ to offer fixes. Your help makes TkinterWeb become more stable and full-featured!

☕ Or, if you’d like to support ongoing development and maintenance, please consider supporting this project by `buying me a coffee <https://buymeacoffee.com/andereoo>`_. Any amount is hugely appreciated!

This project is released under the `MIT License <https://github.com/Andereoo/TkinterWeb/blob/main/LICENSE.md>`_ and is free to use, including for commercial purposes.

If you use this project in a commercial product or derive financial benefit from it, please kindly consider supporting its development with a donation. This helps cover maintenance time and ongoing improvements, which in turn will improve your own software!

.. raw:: html
   
   <a href="https://www.buymeacoffee.com/andereoo" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-violet.png" alt="Buy Me A Coffee" style="height: 35px !important;width: 140px !important;" ></a>

Pages
-----

.. toctree::
   :maxdepth: 1

   usage
   geometry
   dom
   caret
   shrink
   javascript
   faq
   compatibility
   upgrading
   api