CSS YAML Configuration Reference

You can define a CSS client extension with a client-extension.yaml file.

Usage Details

This client-extension.yaml file defines a CSS client extension definition:

able-global-css:
    name: Able CSS
    type: globalCSS
    url: global.css

The required url property defines the CSS resource file’s location. CSS included here is added to the styling already used in the theme. In case of a conflict, the client extension’s CSS overrides the styling already on the page.

The example workspace includes a complete CSS client extension.

YAML Properties

These properties are specific to CSS client extensions:

Name	Data Type	Description
`scope`	String	Beginning in Liferay DXP 2025.Q1/Portal GA132, you can set the scope to `company` to apply the CSS client extension to all the pages of an instance, including the administrative pages (e.g., site administration and the control panel). The default is `layout`, and applies only to site pages as set by the administrator.
`url`	URL	(Required) The path to the CSS file added to the page’s CSS when enabled on a page. The complete URI is prefixed by the `baseURL` value.