@edc4it/reveal.js-railroad 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 EDC4IT B.V.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,96 @@
+# Reveal.js Railroad-diagram
+
+[![Version](https://img.shields.io/npm/v/@edc4it/reveal.js-railroad)](#)
+
+A [reveal.js](https://revealjs.com/) plugin that adds support for Railroad-diagrams.
+It is a thin wrapper around the amazing [Railroad-diagram Generator](https://github.com/tabatkins/railroad-diagrams) project.
+
+![](demo/Screenshot_20240328_141848.png)
+
+---
+
+```html
+<script type="application/railroad">
+  Diagram(
+    'function',
+    NonTerminal('identifier'),
+    '(', ZeroOrMore('param', ','), ')',
+    '{', ZeroOrMore(NonTerminal('statement')), '}');
+</script>
+```
+
+**Important** notes:
+
+- We chose the "holder" to be `<script type="application/railroad">`
+- The containment script is **executed** using [`eval`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/eval). This could be an enormous security risk if you don't know the authors of your slides.
+
+## Quickstart
+
+### Installation
+
+This plugin is published to, and can be installed from, npm.
+
+```console
+npm install add @edc4it/reveal.js-railroad
+```
+
+Or using yarn
+
+```console
+yarn add @edc4it/reveal.js-railroad
+```
+
+### Initialise (as npm library)
+
+```js
+import Reveal from 'reveal.js';
+import ClipCode from '@edc4it/reveal.js-clipcode';
+
+Reveal.initialize({
+  railroad: {
+    // Default values
+    bg: 'unset',
+    pathStroke: '#82e4ff',
+    rectFill: '#00a6ff',
+    rectStroke: 'white',
+    textFill: 'white',
+  },
+  plugins: [RailRoad],
+});
+```
+
+### Add a diagram
+
+For the full syntax of "components" see [Railroad-Diagram components](https://github.com/tabatkins/railroad-diagrams/blob/gh-pages/README-js.md#components)
+
+```html
+<script type="application/railroad">
+  Diagram(
+    'function',
+    NonTerminal('identifier'),
+    '(', ZeroOrMore('param', ','), ')',
+    '{', ZeroOrMore(NonTerminal('statement')), '}');
+</script>
+```
+
+## Global options
+
+```javascript
+Reveal.initialize({
+  railroad: {
+    // Default values
+    bg: 'unset',
+    pathStroke: '#82e4ff',
+    rectFill: '#00a6ff',
+    rectStroke: 'white',
+    textFill: 'white',
+  },
+  plugins: [RailRoad],
+});
+```
+
+- `bg`: the background of the diagram
+- `pathStroke`: the color used for the "path" of the railroad diagram,
+- `rectFill`: 'the fill/background color of the components
+- `rectStroke`: 'the stroke color of the components,
+- `textFill`: color of the text inside the components,

package/dist/impl/main.d.ts

@@ -0,0 +1,3 @@
+import { Options } from '../options.ts';
+
+export declare function run(revealElement: HTMLElement, options: Options): void;

package/dist/impl/styles.d.ts

@@ -0,0 +1,3 @@
+import { Options } from '../options.ts';
+
+export declare function applyStyle(revealElement: HTMLElement, options: Required<Options>): void;

package/dist/options.d.ts

@@ -0,0 +1,13 @@
+import { Options as RevealOptions } from 'reveal.js';
+
+export type Options = {
+    bg: string;
+    textFill: string;
+    pathStroke: string;
+    rectFill: string;
+    rectStroke: string;
+};
+export declare const defaultOptions: Options;
+export type AugmentedRevealOptions = RevealOptions & {
+    railroad?: Options;
+};

package/dist/plugin.d.ts

@@ -0,0 +1,7 @@
+import { Api as RevealAPI } from 'reveal.js';
+
+declare const _default: () => {
+    id: string;
+    init: (deck: RevealAPI) => void;
+};
+export default _default;