-
-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[ADD] web_quick_start_screen: New module
TT50477
- Loading branch information
1 parent
92ca5b0
commit 6300132
Showing
30 changed files
with
1,762 additions
and
0 deletions.
There are no files selected for viewing
1 change: 1 addition & 0 deletions
1
setup/web_quick_start_screen/odoo/addons/web_quick_start_screen
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
../../../../web_quick_start_screen |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
import setuptools | ||
|
||
setuptools.setup( | ||
setup_requires=['setuptools-odoo'], | ||
odoo_addon=True, | ||
) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,137 @@ | ||
================== | ||
Quick Start Screen | ||
================== | ||
|
||
.. | ||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | ||
!! This file is generated by oca-gen-addon-readme !! | ||
!! changes will be overwritten. !! | ||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | ||
!! source digest: sha256:f9c2d78e553eef639adf52a6811c9a92a1b131a13c2882469d1e47f4fe271679 | ||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | ||
.. |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/16.0/web_quick_start_screen | ||
:alt: OCA/web | ||
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png | ||
:target: https://translation.odoo-community.org/projects/web-16-0/web-16-0-web_quick_start_screen | ||
: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=16.0 | ||
:alt: Try me on Runboat | ||
|
||
|badge1| |badge2| |badge3| |badge4| |badge5| | ||
|
||
This module adds a configurable start screen so users can go right into | ||
their more common tasks. | ||
|
||
It can be configured at the user level or just be used as common | ||
screens. | ||
|
||
**Table of contents** | ||
|
||
.. contents:: | ||
:local: | ||
|
||
Use Cases / Context | ||
=================== | ||
|
||
Some users use repeatedly the same actions on and on and sometimes those | ||
actions are so many clicks away which tends to be frustrating. | ||
|
||
Configuration | ||
============= | ||
|
||
To create quick actions: | ||
|
||
- Go to *Settings > Technical > User Interface > Screen actions* and | ||
create o modify an existing one. | ||
- Choose the desired action, a name, a description and an icon. | ||
- You can add an optional context so you can reuse existing actions. | ||
You can use ``ref(<xml_id>)`` to get an id that you can use in your | ||
context. You can also use ``datetime`` and ``context_today`` in that | ||
same way you can do in ``ir.filters``. | ||
|
||
To create quick start screens: | ||
|
||
- Go to *Settings > Technical > User Interface > Quick start screens* | ||
and create or modify an existing one. | ||
- Choose a descriptive name and link some quick screen actions. | ||
|
||
To assign a quick start screen to a user: | ||
|
||
- Go to *Settings > Users and groups > Users* and select one. | ||
- In the *Preferences* tab, *Menus customization* section, you can | ||
choose which *Quick start screen* will that user use. | ||
- If you want to make the user start always in his start screen, in the | ||
same section select the action *Quick Start Screen*. | ||
|
||
To activate the quick start screen menu for a user: | ||
|
||
- Go to *Settings > Users and groups > Users* (with debug mode on) | ||
- In *Technical* groups, set *Quick Start Screen* on. | ||
|
||
Usage | ||
===== | ||
|
||
When you have the proper config, once you login, you'll go to the quick | ||
actions screen. Just click in and start working. | ||
|
||
Known issues / Roadmap | ||
====================== | ||
|
||
- Right now there's no much permissions handling, but it could be made | ||
similarly to how menus deal with them. | ||
- Also we could add the possibility of quick actions for users the same | ||
way that favorite filters work. | ||
- A tour helper that clicked in every defined action would be helpfull | ||
to detect possible issues. | ||
|
||
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_quick_start_screen%0Aversion:%2016.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 | ||
------- | ||
|
||
* Tecnativa | ||
|
||
Contributors | ||
------------ | ||
|
||
- `Tecnativa <https://tecnativa.com>`__ | ||
|
||
- Pedro M. Baeza | ||
- David Vidal | ||
|
||
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/16.0/web_quick_start_screen>`_ project on GitHub. | ||
|
||
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
from . import models |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
# Copyright 2024 Tecnativa - David Vidal | ||
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). | ||
{ | ||
"name": "Quick Start Screen", | ||
"summary": "Configurable start screen for quick actions", | ||
"version": "16.0.1.0.0", | ||
"author": "Tecnativa, Odoo Community Association (OCA)", | ||
"website": "https://github.com/OCA/web", | ||
"license": "AGPL-3", | ||
"category": "web", | ||
"depends": ["web"], | ||
"data": [ | ||
"security/ir.model.access.csv", | ||
"security/security.xml", | ||
"views/quick_screen_action_view.xml", | ||
"views/quick_start_screen_views.xml", | ||
"views/res_users_views.xml", | ||
], | ||
"demo": [ | ||
"demo/quick_screen_action_demo_data.xml", | ||
], | ||
"assets": { | ||
"web.assets_backend": [ | ||
"web_quick_start_screen/static/src/scss/quick_start_screen.scss", | ||
"web_quick_start_screen/static/src/js/kanban_controller.esm.js", | ||
], | ||
}, | ||
} |
57 changes: 57 additions & 0 deletions
57
web_quick_start_screen/demo/quick_screen_action_demo_data.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
<?xml version="1.0" encoding="utf-8" ?> | ||
<odoo noupdate="0"> | ||
<record id="quick_start_screen_action_contacts" model="quick.start.screen.action"> | ||
<field name="name">Contacts</field> | ||
<field | ||
name="description" | ||
><![CDATA[ <span>Browse <b>contacts</b></span>]]></field> | ||
<field name="action_ref_id" ref="base.action_partner_form" /> | ||
<field name="icon_name">fa-users</field> | ||
<field name="color">7</field> | ||
</record> | ||
<record | ||
id="quick_start_screen_action_access_rights" | ||
model="quick.start.screen.action" | ||
> | ||
<field name="name">Access rights</field> | ||
<field | ||
name="description" | ||
><![CDATA[ <span>Explore <b>access rights</b></span>]]></field> | ||
<field name="action_ref_id" ref="base.ir_access_act" /> | ||
<field name="icon_name">fa-eye</field> | ||
<field name="color">4</field> | ||
</record> | ||
<record | ||
id="quick_start_screen_action_config_actions" | ||
model="quick.start.screen.action" | ||
> | ||
<field name="name">Configure screen actions</field> | ||
<field | ||
name="description" | ||
><![CDATA[ <span>Configure this <b>screen actions</b></span>]]></field> | ||
<field | ||
name="action_ref_id" | ||
ref="web_quick_start_screen.quick_start_screen_action_action" | ||
/> | ||
<field | ||
name="image" | ||
type="base64" | ||
file="web_quick_start_screen/static/description/icon.png" | ||
/> | ||
</record> | ||
<record id="quick_start_screen_demo" model="quick.start.screen"> | ||
<field name="name">Demo start screen</field> | ||
<field | ||
name="action_ids" | ||
eval="[Command.link(ref('web_quick_start_screen.quick_start_screen_action_contacts')), Command.link(ref('web_quick_start_screen.quick_start_screen_action_config_actions'))]" | ||
/> | ||
</record> | ||
<record id="base.user_demo" model="res.users"> | ||
<field | ||
name="groups_id" | ||
eval="[Command.link(ref('web_quick_start_screen.group_quick_start_screen'))]" | ||
/> | ||
<field name="quick_start_screen_id" ref="quick_start_screen_demo" /> | ||
<field name="action_id" ref="web_quick_start_screen.start_screen_action" /> | ||
</record> | ||
</odoo> |
Oops, something went wrong.