Skip to content

Commit

Permalink
initial release for web_iconify and web_iconify_proxy
Browse files Browse the repository at this point in the history
  • Loading branch information
jacodottech committed Feb 23, 2025
1 parent 6c72295 commit bf0b5fa
Show file tree
Hide file tree
Showing 27 changed files with 3,816 additions and 5 deletions.
10 changes: 5 additions & 5 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ repos:
hooks:
- id: whool-init
- repo: https://github.com/oca/maintainer-tools
rev: bf9ecb9938b6a5deca0ff3d870fbd3f33341fded
rev: 1a451eff05ce754b25428acc5d542e44050545b0
hooks:
# update the NOT INSTALLABLE ADDONS section above
- id: oca-update-pre-commit-excluded-addons
Expand All @@ -60,7 +60,7 @@ repos:
- --convert-fragments-to-markdown
- id: oca-gen-external-dependencies
- repo: https://github.com/OCA/odoo-pre-commit-hooks
rev: v0.0.33
rev: v0.1.1
hooks:
- id: oca-checks-odoo-module
- id: oca-checks-po
Expand Down Expand Up @@ -96,7 +96,7 @@ repos:
- "[email protected]"
- "[email protected]"
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.6.0
rev: v5.0.0
hooks:
- id: trailing-whitespace
# exclude autogenerated files
Expand All @@ -118,13 +118,13 @@ repos:
- id: mixed-line-ending
args: ["--fix=lf"]
- repo: https://github.com/astral-sh/ruff-pre-commit
rev: v0.6.8
rev: v0.9.7
hooks:
- id: ruff
args: [--fix, --exit-non-zero-on-fix]
- id: ruff-format
- repo: https://github.com/OCA/pylint-odoo
rev: v9.1.3
rev: v9.3.2
hooks:
- id: pylint_odoo
name: pylint with optional checks
Expand Down
101 changes: 101 additions & 0 deletions web_iconify/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
===========
Web Iconify
===========

..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:6eadd39cc54620c27d3acb20fb2d6a05543446e8a7e66fa53253a519afd19096
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
:target: https://odoo-community.org/page/development-status
:alt: Beta
.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
:alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fweb-lightgray.png?logo=github
:target: https://github.com/OCA/web/tree/18.0/web_iconify
:alt: OCA/web
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/web-18-0/web-18-0-web_iconify
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
:target: https://runboat.odoo-community.org/builds?repo=OCA/web&target_branch=18.0
:alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|

This module integrates the Iconify Icon Web Component into Odoo,
allowing developers to easily use a wide variety of icons in their
modules. It uses Iconify's on-demand loading feature.

**Table of contents**

.. contents::
:local:

Usage
=====

To use icons in your Odoo views, use the following syntax:

.. code:: html

<iconify-icon icon="prefix:name"></iconify-icon>

Replace prefix:name with the desired icon name. For example, for
Material Design Icons, you would use mdi:home. You can find a list of
available icons and icon sets on the Iconify website:

https://iconify.design/

Changelog
=========

18.0.1.0.0 (2025-02-23)
-----------------------

- Initial version.

Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/OCA/web/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us to smash it by providing a detailed and welcomed
`feedback <https://github.com/OCA/web/issues/new?body=module:%20web_iconify%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.

Do not contact contributors directly about support or help with technical issues.

Credits
=======

Authors
-------

* jaco.tech

Contributors
------------

- Jaco Waes <[email protected]>

Maintainers
-----------

This module is maintained by the OCA.

.. image:: https://odoo-community.org/logo.png
:alt: Odoo Community Association
:target: https://odoo-community.org

OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.

This module is part of the `OCA/web <https://github.com/OCA/web/tree/18.0/web_iconify>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
Empty file added web_iconify/__init__.py
Empty file.
23 changes: 23 additions & 0 deletions web_iconify/__manifest__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Copyright 2025 jaco.tech
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).

{
"name": "Web Iconify",
"version": "18.0.1.0.0",
"category": "Web",
"summary": "Provides core Iconify integration for Odoo. This module "
"integrates the Iconify SVG framework into Odoo, allowing developers "
"to easily use a wide variety of icons in their modules.",
"author": "jaco.tech, Odoo Community Association (OCA)",
"website": "https://github.com/OCA/web",
"depends": ["web"],
"license": "AGPL-3",
"assets": {
"web.assets_backend": [
"/web_iconify/static/lib/iconify/iconify-icon.js",
"/web_iconify/static/src/css/web_iconify.css",
],
},
"installable": True,
"auto_install": False,
}
3 changes: 3 additions & 0 deletions web_iconify/pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[build-system]
requires = ["whool"]
build-backend = "whool.buildapi"
1 change: 1 addition & 0 deletions web_iconify/readme/CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
- Jaco Waes \<[email protected]\>
3 changes: 3 additions & 0 deletions web_iconify/readme/DESCRIPTION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
This module integrates the Iconify Icon Web Component into Odoo,
allowing developers to easily use a wide variety of icons in their
modules. It uses Iconify's on-demand loading feature.
3 changes: 3 additions & 0 deletions web_iconify/readme/HISTORY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## 18.0.1.0.0 (2025-02-23)

- Initial version.
11 changes: 11 additions & 0 deletions web_iconify/readme/USAGE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
To use icons in your Odoo views, use the following syntax:

``` html
<iconify-icon icon="prefix:name"></iconify-icon>
```

Replace prefix:name with the desired icon name. For example, for
Material Design Icons, you would use mdi:home. You can find a list of
available icons and icon sets on the Iconify website:

<https://iconify.design/>
Loading

0 comments on commit bf0b5fa

Please sign in to comment.