Metadata-Version: 2.1
Name: odoo-addon-base_kanban_stage
Version: 19.0.1.0.0.2
Requires-Dist: odoo==19.0.*
Summary: Provides stage model and abstract logic for inheritance
Home-page: https://github.com/OCA/server-tools
License: LGPL-3
Author: LasLabs, Odoo Community Association (OCA)
Author-email: support@odoo-community.org
Classifier: Programming Language :: Python
Classifier: Framework :: Odoo
Classifier: Framework :: Odoo :: 19.0
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
Description-Content-Type: text/x-rst

.. image:: https://odoo-community.org/readme-banner-image
   :target: https://odoo-community.org/get-involved?utm_source=readme
   :alt: Odoo Community Association

======================
Kanban - Stage Support
======================

.. 
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! This file is generated by oca-gen-addon-readme !!
   !! changes will be overwritten.                   !!
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! source digest: sha256:fba70c1c1eddf1cb2e5833d422c79bcde16a5e7bd4273f3528fdf3dc7536e5cf
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |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/license-LGPL--3-blue.png
    :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
    :alt: License: LGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github
    :target: https://github.com/OCA/server-tools/tree/19.0/base_kanban_stage
    :alt: OCA/server-tools
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
    :target: https://translation.odoo-community.org/projects/server-tools-19-0/server-tools-19-0-base_kanban_stage
    :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/server-tools&target_branch=19.0
    :alt: Try me on Runboat

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

This module provides a stage model compatible with Kanban views and the
standard views needed to manage these stages. It also provides the
``base.kanban.abstract`` model, which can be inherited to add support
for Kanban views with stages to any other model. Lastly, it includes a
base Kanban view that can be extended as needed.

**Table of contents**

.. contents::
   :local:

Configuration
=============

No configuration is needed or possible.

Usage
=====

- Inherit from ``base.kanban.abstract`` to add Kanban stage
  functionality to the child model:

.. code:: python

   class MyModel(models.Model):
       _name = "my.model"
       _inherit = "base.kanban.abstract"

- Extend the provided base Kanban view
  (``base_kanban_abstract_view_kanban``) as needed by the child model
  while making sure to set the ``mode`` to ``primary`` so that
  inheritance works properly. The base view has four ``name`` attributes
  intended to provide convenient XPath access to different parts of the
  Kanban card. They are ``card_dropdown_menu``, ``card_header``,
  ``card_body`` and ``card_footer``:

.. code:: xml

   <record id="my_model_view_kanban" model="ir.ui.view">
       <field name="name">My Model - Kanban View</field>
       <field name="model">my.model</field>
       <field name="mode">primary</field>
       <field name="inherit_id" ref="base_kanban_stage.base_kanban_abstract_view_kanban"/>
       <field name="arch" type="xml">
           <xpath expr="//div[@name='card_header']">
               <!-- Add header content here -->
           </xpath>
           <xpath expr="//main[@name='card_body']">
               <!-- Add body content here -->
           </xpath>
       </field>
   </record>

- To manage stages, go to Settings > Technical > Kanban > Stages.

Known issues / Roadmap
======================

- The grouping logic used by ``base.kanban.abstract`` currently does not
  support additional domains and alternate sort orders.

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

Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-tools/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/server-tools/issues/new?body=module:%20base_kanban_stage%0Aversion:%2019.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
-------

* LasLabs

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

- Dave Lasley <dave@laslabs.com>
- Oleg Bulkin <obulkin@laslabs.com>
- Daniel Reis <dreis.pt@hotmail.com>
- Alex Comba <alex.comba@agilebg.com>
- Miquel Raïch <miquel.raich@forgeflow.com>
- Helly kapatel <helly.kapatel@initos.com>
- Jasmin Solanki <jasmin.solanki@forgeflow.com>

Other credits
-------------

- Icon: `Odoo Community
  Association <https://odoo-community.org/logo.png>`__.

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/server-tools <https://github.com/OCA/server-tools/tree/19.0/base_kanban_stage>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
