add examples readme and add title to example apps

This commit is contained in:
Rene Haas
2022-11-25 11:52:55 +01:00
parent a89d4a7921
commit 2122378a5e
6 changed files with 39 additions and 16 deletions
+24
View File
@@ -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` |
+11 -11
View File
@@ -1,13 +1,13 @@
<!doctype html>
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Example</title>
<base href="/">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="icon" type="image/x-icon" href="favicon.ico">
</head>
<body>
<app-root></app-root>
</body>
<head>
<meta charset="utf-8" />
<base href="/" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<link rel="icon" type="image/x-icon" href="favicon.ico" />
<title>OverlayScrollbars & Angular</title>
</head>
<body>
<app-root></app-root>
</body>
</html>
+1 -1
View File
@@ -4,7 +4,7 @@
<meta charset="UTF-8" />
<link rel="icon" type="image/svg+xml" href="/vite.svg" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Vite + React + TS</title>
<title>OverlayScrollbars & React</title>
</head>
<body>
<div id="root"></div>
+1 -1
View File
@@ -5,7 +5,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="theme-color" content="#000000" />
<link rel="shortcut icon" type="image/ico" href="/src/assets/favicon.ico" />
<title>Solid App</title>
<title>OverlayScrollbars & Solid</title>
</head>
<body>
<noscript>You need to enable JavaScript to run this app.</noscript>
+1 -2
View File
@@ -4,8 +4,7 @@
</script>
<svelte:head>
<title>Home</title>
<meta name="description" content="Svelte demo app" />
<title>OverlayScrollbars & Svelte</title>
</svelte:head>
<OverlayScrollbarsComponent style="height: 222px; width: 222px" :options="options">
+1 -1
View File
@@ -4,7 +4,7 @@
<meta charset="UTF-8" />
<link rel="icon" href="/favicon.ico" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Vite App</title>
<title>OverlayScrollbars & Vue</title>
</head>
<body>
<div id="app"></div>