@cmusei/console-forge 0.15.0 → 0.17.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +22 -1
- package/fesm2022/cmusei-console-forge.mjs +52 -27
- package/fesm2022/cmusei-console-forge.mjs.map +1 -1
- package/lib/components/console/console.component.d.ts +2 -0
- package/lib/components/console-toolbar/console-toolbar.component.d.ts +5 -1
- package/lib/config/console-forge-config.d.ts +6 -3
- package/lib/models/console-toolbar-context.d.ts +2 -0
- package/lib/services/canvas-recorder/canvas-recording.d.ts +0 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -69,7 +69,28 @@ export const appConfig: ApplicationConfig = {
|
|
|
69
69
|
|
|
70
70
|
See [the config definition](https://github.com/cmu-sei/console-forge/blob/main/projects/console-forge/src/lib/config/console-forge-config.ts) in the library for available options and defaults.
|
|
71
71
|
|
|
72
|
-
#
|
|
72
|
+
# The Toolbar
|
|
73
|
+
|
|
74
|
+
ConsoleForge's `ConsoleComponent` includes a default toolbar that exposes a console's various functions to the end user (e.g. taking screenshots, going fullscreen, using the console clipboard, and so on). You can either use this default toolbar, or replace it with your own custom component.
|
|
75
|
+
|
|
76
|
+
## Setting up the default toolbar
|
|
77
|
+
|
|
78
|
+
To minimize impact on client applications using ConsoleForge, its default toolbar uses [PicoCSS](https://picocss.com/), a lightweight CSS framework. To avoid contaminating the global DOM with PicoCSS, ConsoleForge expects to find and download its assets from your app's `assets` directory. To make this happen, add this to your `angular.json` to make the included assets available in your app's `assets` directory:
|
|
79
|
+
|
|
80
|
+
```json
|
|
81
|
+
"assets": [
|
|
82
|
+
// any other assets you might have
|
|
83
|
+
{
|
|
84
|
+
"glob": "**/*",
|
|
85
|
+
"input": "node_modules/@cmusei/console-forge/assets",
|
|
86
|
+
"output": "assets/"
|
|
87
|
+
}
|
|
88
|
+
]
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
**NOTE:** We know this is an installation pain point and are considering alternative ways to make this happen so that modifying your angular.json isn't necessary.
|
|
92
|
+
|
|
93
|
+
## Creating a custom toolbar
|
|
73
94
|
|
|
74
95
|
ConsoleForge provides a capable toolbar out of the box, but as the only visible element of the library, we felt it important to support customization so that ConsoleForge can happily live within the design language of any app.
|
|
75
96
|
|