adapt-authoring-ui 1.5.5 → 1.5.7

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.
Files changed (6) hide show
  1. package/adapt-authoring.json +1 -3
  2. package/app/modules/notify/plugins/alert/less/alert.less +4 -1
  3. package/docs/ui.md +38 -0
  4. package/package.json +1 -1
  5. package/docs/migrating-from-legacy.md +0 -19
  6. package/docs/ui-extensions.md +0 -15
package/adapt-authoring.json CHANGED
@@ -3,9 +3,7 @@
3
3
  "enable": true,
4
4
  "manualPlugins": ["docs/plugins/uidocs.js"],
5
5
  "manualPages": {
6
- "migrating-from-legacy.md": "ui",
7
- "ui-extensions.md": "ui",
8
- "ui-libraries.md": "ui"
6
+ "ui.md": "development"
9
7
  }
10
8
  }
11
9
  }
package/app/modules/notify/plugins/alert/less/alert.less CHANGED
@@ -30,6 +30,9 @@
30
30
  font-size: 115%;
31
31
  }
32
32
  }
33
+ .swal2-html-container {
34
+ max-height: 300px;
35
+ }
33
36
  .swal2-icon {
34
37
  &.swal2-error {
35
38
  border-color: @alert-color;
@@ -71,4 +74,4 @@ body.swal2-toast-shown .swal2-container.swal2-top-right {
71
74
  color: white;
72
75
  }
73
76
  }
74
- }
77
+ }
package/docs/ui.md ADDED
@@ -0,0 +1,38 @@
1
+ # Working with the UI
2
+
3
+ ## Extending the UI
4
+
5
+ The UI can be extended easily from an Adapt authoring tool module.
6
+
7
+ ### Register your plugin
8
+ Register your UI plugin by calling the [UIModule#addUiPlugin](https://tomtaylor.codes/ls/jsdoc3/UIModule.html#addUiPlugin) function from your own module's [init](https://tomtaylor.codes/ls/jsdoc3/AbstractModule.html#init) function, which ensures that your plugin code is included in the build of the front-end app.
9
+
10
+ Any files found in this folder will be included in the app build process, so make sure you include all front-end code, Handlebars templates and LESS/CSS in here.
11
+
12
+ ### Define language strings
13
+ Add any translated language strings to the `/lang` folder in the root of your module
14
+
15
+ ### Resources
16
+
17
+ - **GitHub template**: You can use the following GitHub template repository as a starting point:
18
+ [adapt-security/adapt-authoring-uiplugintemplate](https://github.com/adapt-security/adapt-authoring-uiplugintemplate)
19
+
20
+ ## Migrating from legacy
21
+
22
+ > During development, set `adapt-authoring-ui.isProduction` to `false` in your config file for easier debugging (all .js files are served directly, rather using than the minified adapt.js file)
23
+
24
+ ### Changes
25
+
26
+ #### Permissions
27
+
28
+ The permissions mechanism has been completely rewritten to use permissions 'scopes' which are human-readable strings. Permissions utilities are now accessed directly from the SessionModel.
29
+
30
+ - `Origin.permissions.hasPermission` => `Origin.sessionModel.hasScopes`
31
+ - `hasPermission` => `ifHasScopes`
32
+
33
+ #### APIs
34
+
35
+ ##### TODO
36
+
37
+ #### Language strings
38
+ Language strings are now served directly from the back-end server, and therefore need to be stored in the root `lang` folder of your authoring tool module. The server will need to be restarted for any changes to these to be recognised.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "adapt-authoring-ui",
3
- "version": "1.5.5",
3
+ "version": "1.5.7",
4
4
  "description": "Front-end application for the Adapt authoring tool",
5
5
  "homepage": "https://github.com/adapt-security/adapt-authoring-ui",
6
6
  "license": "GPL-3.0",
package/docs/migrating-from-legacy.md DELETED
@@ -1,19 +0,0 @@
1
- # Migrating from legacy
2
-
3
- > During development, set `adapt-authoring-ui.isProduction` to `false` in your config file for easier debugging (all .js files are served directly, rather using than the minified adapt.js file)
4
-
5
- ## Changes
6
-
7
- ### Permissions
8
-
9
- The permissions mechanism has been completely rewritten to use permissions 'scopes' which are human-readable strings. Permissions utilities are now accessed directly from the SessionModel.
10
-
11
- - `Origin.permissions.hasPermission` => `Origin.sessionModel.hasScopes`
12
- - `hasPermission` => `ifHasScopes`
13
-
14
- ### APIs
15
-
16
- #### TODO
17
-
18
- ### Language strings
19
- Language strings are now served directly from the back-end server, and therefore need to be stored in the root `lang` folder of your authoring tool module. The server will need to be restarted for any changes to these to be recognised.
package/docs/ui-extensions.md DELETED
@@ -1,15 +0,0 @@
1
- # Extending the UI
2
- The UI can be extended easily from an Adapt authoring tool module.
3
-
4
- ## Register your plugin
5
- Register your UI plugin by calling the [UIModule#addUiPlugin](https://tomtaylor.codes/ls/jsdoc3/UIModule.html#addUiPlugin) function from your own module's [init](https://tomtaylor.codes/ls/jsdoc3/AbstractModule.html#init) function, which ensures that your plugin code is included in the build of the front-end app.
6
-
7
- Any files found in this folder will be included in the app build process, so make sure you include all front-end code, Handlebars templates and LESS/CSS in here.
8
-
9
- ## Define language strings
10
- Add any translated language strings to the `/lang` folder in the root of your module
11
-
12
- ## Resources
13
-
14
- - **GitHub template**: You can use the following GitHub template repository as a starting point:
15
- [adapt-security/adapt-authoring-uiplugintemplate](https://github.com/adapt-security/adapt-authoring-uiplugintemplate)