@itrocks/menu 0.0.1

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 (7) hide show
  1. package/LICENSE +14 -0
  2. package/README.md +9 -0
  3. package/cjs/menu.d.ts +15 -0
  4. package/cjs/menu.html +28 -0
  5. package/cjs/menu.js +39 -0
  6. package/css/menu.css +33 -0
  7. package/package.json +51 -0
package/LICENSE ADDED
@@ -0,0 +1,14 @@
1
+ ISC License
2
+ Copyright (C) 2024, Baptiste Pillot <baptiste@pillot.fr>
3
+
4
+ Permission to use, copy, modify, and/or distribute this software for any
5
+ purpose with or without fee is hereby granted, provided that the above
6
+ copyright notice and this permission notice appear in all copies.
7
+
8
+ THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9
+ WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10
+ MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11
+ ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12
+ WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
13
+ OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
14
+ CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,9 @@
1
+ [![npm version](https://img.shields.io/npm/v/@itrocks/menu?logo=npm)](https://www.npmjs.org/package/@itrocks/menu)
2
+ [![npm downloads](https://img.shields.io/npm/dm/@itrocks/menu)](https://www.npmjs.org/package/@itrocks/menu)
3
+ [![GitHub](https://img.shields.io/github/last-commit/itrocks-ts/menu?color=2dba4e&label=commit&logo=github)](https://github.com/itrocks-ts/menu)
4
+ [![issues](https://img.shields.io/github/issues/itrocks-ts/menu)](https://github.com/itrocks-ts/menu/issues)
5
+ [![discord](https://img.shields.io/discord/1314141024020467782?color=7289da&label=discord&logo=discord&logoColor=white)](https://25.re/ditr)
6
+
7
+ # menu
8
+
9
+ A flexible and accessible customizable main menu component with sidebar layout.
package/cjs/menu.d.ts ADDED
@@ -0,0 +1,15 @@
1
+ export declare class Menu {
2
+ blocks: MenuBlock[];
3
+ constructor(config?: Record<string, Record<string, string>>);
4
+ loadConfig(config: Record<string, Record<string, string>>): void;
5
+ }
6
+ export declare class MenuBlock {
7
+ items: MenuItem[];
8
+ title: string;
9
+ constructor(title: string);
10
+ }
11
+ export declare class MenuItem {
12
+ link: string;
13
+ title: string;
14
+ constructor(title: string, link: string);
15
+ }
package/cjs/menu.html ADDED
@@ -0,0 +1,28 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <link href="../css/menu.css" rel="stylesheet">
5
+ <meta charset="utf-8">
6
+ <title>it.rocks application home</title>
7
+ </head>
8
+ <body>
9
+ <nav class="app menu">
10
+ <!--BEGIN-->
11
+
12
+ <ul>
13
+ <!--blocks-->
14
+ <li class="{title.toRoute}">
15
+ <h3>{title.tr}</h3>
16
+ <ul>
17
+ <!--items-->
18
+ <li><a href="app://(link)" target="main">{title.tr}</a></li>
19
+ <!--end-->
20
+ </ul>
21
+ </li>
22
+ <!--end-->
23
+ </ul>
24
+
25
+ <!--END-->
26
+ </nav>
27
+ </body>
28
+ </html>
package/cjs/menu.js ADDED
@@ -0,0 +1,39 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.MenuItem = exports.MenuBlock = exports.Menu = void 0;
4
+ class Menu {
5
+ blocks = [];
6
+ constructor(config) {
7
+ if (config) {
8
+ this.loadConfig(config);
9
+ }
10
+ }
11
+ loadConfig(config) {
12
+ for (const [blockTitle, blockItems] of Object.entries(config)) {
13
+ const block = new MenuBlock(blockTitle);
14
+ for (const [link, title] of Object.entries(blockItems)) {
15
+ block.items.push(new MenuItem(title, link));
16
+ }
17
+ this.blocks.push(block);
18
+ }
19
+ }
20
+ }
21
+ exports.Menu = Menu;
22
+ class MenuBlock {
23
+ items = [];
24
+ title;
25
+ constructor(title) {
26
+ this.title = title;
27
+ }
28
+ }
29
+ exports.MenuBlock = MenuBlock;
30
+ class MenuItem {
31
+ link;
32
+ title;
33
+ constructor(title, link) {
34
+ this.link = link;
35
+ this.title = title;
36
+ }
37
+ }
38
+ exports.MenuItem = MenuItem;
39
+ //# sourceMappingURL=menu.js.map
package/css/menu.css ADDED
@@ -0,0 +1,33 @@
1
+ body > .app.menu {
2
+ overflow: hidden auto;
3
+ width: 200px;
4
+ }
5
+ body > .app.menu a {
6
+ display: block;
7
+ }
8
+ body > .app.menu ul {
9
+ margin: 0;
10
+ padding: 0;
11
+ }
12
+ body > .app.menu > ul {
13
+ white-space: nowrap;
14
+ }
15
+ body > .app.menu > ul > li > h3 {
16
+ background-color: #ddd;
17
+ background-position: 10px center;
18
+ background-repeat: no-repeat;
19
+ background-size: 24px;
20
+ font-weight: normal;
21
+ margin: 2px 0;
22
+ padding: 1em 0 1em 40px;
23
+ }
24
+ body > .app.menu > ul > li > ul > li {
25
+ margin: 2px 0;
26
+ transition: background-color 0.1s;
27
+ }
28
+ body > .app.menu > ul > li > ul > li:hover {
29
+ background-color: #f4f4f4;
30
+ }
31
+ body > .app.menu > ul > li > ul > li > a {
32
+ padding: 0.8em 0 0.8em 10px;
33
+ }
package/package.json ADDED
@@ -0,0 +1,51 @@
1
+ {
2
+ "author": {
3
+ "name": "Baptiste Pillot",
4
+ "email": "baptiste@pillot.fr"
5
+ },
6
+ "dependencies": {
7
+ },
8
+ "description": "A flexible and accessible customizable main menu component with sidebar layout",
9
+ "devDependencies": {
10
+ "sass": "^1.83",
11
+ "typescript": "~5.6"
12
+ },
13
+ "engines": {
14
+ "node": ">=18"
15
+ },
16
+ "exports": "./cjs/menu.js",
17
+ "homepage": "https://it.rocks",
18
+ "files": [
19
+ "LICENSE",
20
+ "README.md",
21
+ "cjs/*",
22
+ "css/*",
23
+ "!*.map"
24
+ ],
25
+ "keywords": [
26
+ "component",
27
+ "front-end",
28
+ "it.rocks",
29
+ "layout",
30
+ "menu",
31
+ "navigation",
32
+ "responsive",
33
+ "sidebar",
34
+ "template",
35
+ "UI",
36
+ "UX",
37
+ "web"
38
+ ],
39
+ "license": "ISC",
40
+ "name": "@itrocks/menu",
41
+ "repository": {
42
+ "type": "git",
43
+ "url": "git+https://github.com/itrocks-ts/menu.git"
44
+ },
45
+ "scripts": {
46
+ "build": "tsc -p tsconfig.json && cp src/*.html cjs/ && npm run build:css",
47
+ "build:css": "sass --no-source-map src:css"
48
+ },
49
+ "types": "./cjs/menu.d.ts",
50
+ "version": "0.0.1"
51
+ }