README.md

UI Styles

Adds various style and UI features to Frappe/ERPNext. Features are opt-in: they stay passive until a System Manager enables them via the UI Styles workspace.

Important

Functions and features in this app are provided as-is, without warranty. They are tested only against the Frappe/ERPNext versions used in branch name; other versions may behave differently. Even though they have no write functions, they are not tested against information leaks due to permission settings.

Agent conventions: see AGENTS.md.

Doc Table

Registers fieldtype Doc Table: a read-only form grid of related real DocTypes (not child tables). See ui_styles/doc_table/README.md.

Desk Background

Opt-in Desk background tint. See ui_styles/desk_background/README.md.

List Scroll

Opt-in dense Desk list layout with a shared horizontal scrollbar. See ui_styles/list_scroll/README.md.

Installation

You can install this app using the bench CLI:

cd $PATH_TO_YOUR_BENCH
bench get-app $URL_OF_THIS_REPO --branch develop
bench install-app ui_styles

Contributing

This app uses pre-commit for code formatting and linting. Please install pre-commit and enable it for this repository:

cd apps/ui_styles
pre-commit install

Pre-commit is configured to use the following tools for checking and formatting your code:

• ruff
• eslint
• prettier
• pyupgrade

CI

This app can use GitHub Actions for CI. The following workflows are configured:

• CI: Installs this app and runs unit tests on every push to version-15 branch.
• Linters: Runs Frappe Semgrep Rules and pip-audit on every pull request.

License

gpl-3.0