From 2122378a5edb4b381f4dcc879ee6d59f265a7555 Mon Sep 17 00:00:00 2001 From: Rene Haas Date: Fri, 25 Nov 2022 11:52:55 +0100 Subject: [PATCH] add examples readme and add title to example apps --- examples/README.md | 24 ++++++++++++++++++++++++ examples/angular/src/index.html | 22 +++++++++++----------- examples/react/index.html | 2 +- examples/solid/index.html | 2 +- examples/svelte/src/routes/+page.svelte | 3 +-- examples/vue/index.html | 2 +- 6 files changed, 39 insertions(+), 16 deletions(-) create mode 100644 examples/README.md diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 0000000..4f3adc2 --- /dev/null +++ b/examples/README.md @@ -0,0 +1,24 @@ +# Examples + +Run example applications with `OverlayScrollbars`. + +> __Note__: All commands must be executed from the root directory of the repository unless stated differently. + +## Install and Build + +Before you can start any application you have to install all dependencies and build the library: + +1. `npm i` +2. `npm run build:os` + +## Run Example + +The following examples are available: + +| App | Command | +| :--- | :--- | +| React | `npm run example:react` | +| Vue | `npm run example:vue` | +| Angular | `npm run example:ngx` | +| Svelte | `npm run example:svelte` | +| Solid | `npm run example:solid` | diff --git a/examples/angular/src/index.html b/examples/angular/src/index.html index 0b2a9d5..f318ec4 100644 --- a/examples/angular/src/index.html +++ b/examples/angular/src/index.html @@ -1,13 +1,13 @@ - + - - - Example - - - - - - - + + + + + + OverlayScrollbars & Angular + + + + diff --git a/examples/react/index.html b/examples/react/index.html index e0d1c84..ae29146 100644 --- a/examples/react/index.html +++ b/examples/react/index.html @@ -4,7 +4,7 @@ - Vite + React + TS + OverlayScrollbars & React
diff --git a/examples/solid/index.html b/examples/solid/index.html index 48c59fc..9c49764 100644 --- a/examples/solid/index.html +++ b/examples/solid/index.html @@ -5,7 +5,7 @@ - Solid App + OverlayScrollbars & Solid diff --git a/examples/svelte/src/routes/+page.svelte b/examples/svelte/src/routes/+page.svelte index 8e02c17..18bad84 100644 --- a/examples/svelte/src/routes/+page.svelte +++ b/examples/svelte/src/routes/+page.svelte @@ -4,8 +4,7 @@ - Home - + OverlayScrollbars & Svelte diff --git a/examples/vue/index.html b/examples/vue/index.html index 11603f8..d7cdcfb 100644 --- a/examples/vue/index.html +++ b/examples/vue/index.html @@ -4,7 +4,7 @@ - Vite App + OverlayScrollbars & Vue