You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/conceptual-guides/add-on-styles-loader.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,23 +10,23 @@ myst:
10
10
# Add-ons styles loader
11
11
12
12
Add-ons that are compatible with the `@plone/registry` may declare styles that should be loaded by the app.
13
-
Currently the loader loads styles for both the end user interface (public UI) part, which displays content to both authenticated and anonymous users, and the content management system user interface (CMS UI) part of the app.
13
+
Currently the loader loads styles for both the end user interface (Public UI) part, which displays content to both authenticated and anonymous users, and the content management system user interface (CMSUI) part of the app.
14
14
15
15
## Public UI styles
16
16
17
-
To load public UI styles, create a file {file}`styles/main.css` at the root of your add-on package to serve as the entry point.
18
-
This file is a `.css` file containing the styles that you want your app to load for the public UI.
17
+
To load Public UI styles, create a file {file}`styles/main.css` at the root of your add-on package to serve as the entry point.
18
+
This file is a `.css` file containing the styles that you want your app to load for the Public UI.
19
19
20
-
## CMS UI styles
20
+
## CMSUI styles
21
21
22
-
Similar to the public UI, you can create a file {file}`styles/cmsui.css` at the root of your add-on package to serve as the entry point for the CMS UI styles.
23
-
This file is also a CSS file containing the styles that you want your app to load for the CMS UI.
22
+
Similar to the Public UI, you can create a file {file}`styles/cmsui.css` at the root of your add-on package to serve as the entry point for the CMSUI styles.
23
+
This file is also a CSS file containing the styles that you want your app to load for the CMSUI.
24
24
25
25
`@plone/registry` has a helper utility `createAddonsStyleLoader` which generates an add-ons loader file.
26
26
That file contains the aggregated files from all the registered add-ons, keeping the order in which they were defined.
27
27
28
28
This loader is also a `.css` file and is placed in the root of your application.
29
-
By default, it's called {file}`publicui.css` for the public UI and {file}`cmsui.css` for the CMS UI.
29
+
By default, it's called {file}`publicui.css` for the Public UI and {file}`cmsui.css` for the CMSUI.
30
30
31
31
```{important}
32
32
This file is generated and maintained by `@plone/registry`.
Copy file name to clipboardExpand all lines: docs/reference/conventions.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,12 +22,12 @@ We follow the mantra, "If it works, don't change it."
22
22
23
23
This document highlights the differences and additions compared to Volto conventions.
24
24
25
-
## Separate builds for public and CMSUI
25
+
## Separate builds for Public UI and CMSUI
26
26
27
-
We are aiming for the possibility of having two separate builds: one for the public theme and another for the CMS UI.
27
+
We are aiming for the possibility of having two separate builds: one for the public theme called {term}`Public UI`and another for the {term}`CMSUI`.
28
28
Thus, we need to ensure that the codebase can support this separation and have this in mind when developing new features.
29
29
This will impose some constraints, such as avoiding the use of Tailwind CSS classes in structural components, since the public theme might not use Tailwind CSS.
30
-
Also, the public UI cannot rely on any CMSUI-specific styles or components.
30
+
Also, the Public UI cannot rely on any CMSUI-specific styles or components.
31
31
32
32
## Storybook
33
33
@@ -74,7 +74,7 @@ These styles are very simple ("vanilla") and easy to override with your own styl
74
74
You can also use these in Volto projects by installing the `@plone/components` package.
75
75
76
76
The Tailwind-based components are meant for public themes that also use Tailwind CSS, like the default Seven theme (`@plone/agave`).
77
-
They're also used in the CMS UI, which is based on Tailwind CSS.
77
+
They're also used in the CMSUI, which is based on Tailwind CSS.
78
78
79
79
Check out the Storybook for this package at [@plone/components Storybook](https://plone-components.readthedocs.io/latest/?path=/docs/introduction--docs).
Copy file name to clipboardExpand all lines: packages/registry/docs/conceptual-guides/add-on-styles-loader.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,23 +10,23 @@ myst:
10
10
# Add-ons styles loader
11
11
12
12
Add-ons that are compatible with the `@plone/registry` may declare styles that should be loaded by the app.
13
-
Currently the loader loads styles for both the end user interface (public UI) part, which displays content to both authenticated and anonymous users, and the content management system user interface (CMS UI) part of the app.
13
+
Currently, the loader loads styles for both the end user interface (Public UI) part, which displays content to both authenticated and anonymous users, and the content management system user interface (CMSUI) part of the app.
14
14
15
15
## Public UI Styles
16
16
17
-
To load public UI styles, create a file {file}`styles/main.css` at the root of your add-on package to serve as the entry point.
18
-
This file is a `.css` file containing the styles that you want your app to load for the public UI.
17
+
To load Public UI styles, create a file {file}`styles/main.css` at the root of your add-on package to serve as the entry point.
18
+
This file is a `.css` file containing the styles that you want your app to load for the Public UI.
19
19
20
-
## CMS UI Styles
20
+
## CMSUI Styles
21
21
22
-
Similar to the public UI, you can create a file {file}`styles/cmsui.css` at the root of your add-on package to serve as the entry point for the CMS UI styles.
23
-
This file is also a CSS file containing the styles that you want your app to load for the CMS UI.
22
+
Similar to the Public UI, you can create a file {file}`styles/cmsui.css` at the root of your add-on package to serve as the entry point for the CMSUI styles.
23
+
This file is also a CSS file containing the styles that you want your app to load for the CMSUI.
24
24
25
25
`@plone/registry` has a helper utility `createAddonsStyleLoader` which generates an add-ons loader file.
26
26
That file contains the aggregated files from all the registered add-ons, keeping the order in which they were defined.
27
27
28
28
This loader is also a `.css` file and is placed in the root of your application.
29
-
By default, it's called {file}`publicui.css` for the public UI and {file}`cmsui.css` for the CMS UI.
29
+
By default, it's called {file}`publicui.css` for the Public UI and {file}`cmsui.css` for the CMSUI.
30
30
31
31
```{important}
32
32
This file is generated and maintained by `@plone/registry`.
0 commit comments