Skip to content

Commit ffda6cf

Browse files
Manas-Kengeacsrstevepiercy
authored
Add /@@test-rendering views to docs (#1903)
* mention of the /@@test-rendering views * change location, add screenshots, remove url * Sentence case headings * Simplify the structure. - Avoid enumerating headings. - Use complete sentences and headings that align with the content. * crop images * resize images * adjust width * final images --------- Co-authored-by: Armin Stross-Radschinski <[email protected]> Co-authored-by: Steve Piercy <[email protected]>
1 parent 9de2d11 commit ffda6cf

File tree

4 files changed

+76
-0
lines changed

4 files changed

+76
-0
lines changed
Loading

docs/_static/test-rendering/icons.png

31.6 KB
Loading
51.5 KB
Loading

docs/classic-ui/theming/create-add-on.md

+76
Original file line numberDiff line numberDiff line change
@@ -141,3 +141,79 @@ $state-colors: map-merge($state-colors, $custom-colors);
141141
Inside the file `theme/_custom.scss` you can write all your custom CSS/Sass code to adapt the theme to your needs.
142142
Feel free to add more files inside the `scss/` folder to make your code more readable.
143143
Don't forget to import your custom files in `scss/theme.scss`.
144+
145+
146+
## Styles test rendering
147+
148+
Plone's Classic UI includes special demonstration views that render ready-made examples of interface components using your site's active theme.
149+
These views help developers verify styling implementation and explore available UI patterns.
150+
These views work in any context.
151+
No special permissions are required.
152+
153+
Append one of the following view names with a leading slash `/` to any Plone site URL.
154+
155+
- `/@@test-rendering`
156+
- `/@@test-rendering-cheatsheet`
157+
- `/@@test-rendering-icons`
158+
159+
Each view name corresponds to a named tab in Plone as described in the following sections.
160+
161+
162+
### {guilabel}`Test Rendering`
163+
164+
The {guilabel}`Test Rendering` tab at the view name `@@test-rendering` displays Bootstrap style status message examples.
165+
It shows all alert variants including:
166+
167+
- Success, warning, and error notifications
168+
- Dismissible alerts
169+
- Contextual color examples
170+
171+
````{card}
172+
```{image} /_static/test-rendering/test-rendering.png
173+
:alt: Test Rendering
174+
:target: /_static/test-rendering/test-rendering.png
175+
```
176+
+++
177+
_Test Rendering_
178+
````
179+
180+
### {guilabel}`Bootstrap Cheatsheet`
181+
182+
The {guilabel}`Bootstrap Cheatsheet` tab at the view name `@@test-rendering-cheatsheet` displays the kitchen sink of Bootstrap components.
183+
It includes the following examples and dozens more:
184+
185+
- color mode switcher interface, located in the lower right corner of the browser window
186+
- grid layout examples
187+
- form control variants
188+
- navigation components
189+
- interactive element states
190+
191+
````{card}
192+
```{image} /_static/test-rendering/bootstrap-cheatsheet.png
193+
:alt: Bootstrap Cheatsheet
194+
:target: /_static/test-rendering/bootstrap-cheatsheet.png
195+
```
196+
+++
197+
_Bootstrap Cheatsheet_
198+
````
199+
200+
### {guilabel}`Icons`
201+
202+
The {guilabel}`Icons` tab at the view name `@@test-rendering-icons` displays a few icon classes.
203+
It includes the following examples:
204+
205+
- icon resolver usage
206+
- code samples for both URL and tag generation
207+
208+
````{card}
209+
```{image} /_static/test-rendering/icons.png
210+
:alt: Icons
211+
:target: /_static/test-rendering/icons.png
212+
```
213+
+++
214+
_Icons_
215+
````
216+
217+
```{seealso}
218+
For an overview of UI components in Volto, see its [Storybook](https://6.docs.plone.org/storybook/).
219+
```

0 commit comments

Comments
 (0)