@unlk/keymaster 1.0.3 → 1.0.4

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.
package/CHANGELOG.md CHANGED
@@ -2,10 +2,16 @@
2
2
 
3
3
  All notable changes to this project will be documented in this file.
4
4
 
5
+ ## [1.0.4] - 2025-04-25
6
+
7
+ ### Updated
8
+ Readme Logo
9
+ Changelog function for github build
10
+
5
11
  ## [1.0.3] - 2025-04-25
6
12
 
7
13
  ### Updated
8
- Bootsrap 5.3.5
14
+ Bootstrap 5.3.5
9
15
 
10
16
  ### Added
11
17
  - Spinners
package/README.md CHANGED
@@ -5,10 +5,19 @@
5
5
  <br />
6
6
  <div align="center">
7
7
  <a href="https://www.unlock.com/">
8
- <img src="images/unlock.svg" alt="Unlock Logo">
8
+ <svg width="54" height="88" viewBox="0 0 54 88" fill="none" xmlns="http://www.w3.org/2000/svg">
9
+ <path d="M42.5456 70.7213H53.182L31.9092 42.5022H21.2728L42.5456 70.7213Z" fill="#CBEBF8"/>
10
+ <path d="M42.5456 70.7213H31.9092V88H42.5456V70.7213Z" fill="#CBEBF8"/>
11
+ <path d="M31.9092 70.7213H42.5456L21.2728 42.5022H10.6364L31.9092 70.7213Z" fill="#66CDF3"/>
12
+ <path d="M31.9092 70.7213V88H21.2728V70.7213H31.9092Z" fill="#66CDF3"/>
13
+ <path d="M21.2728 70.7213H31.9092L10.6364 42.5022V21.2728C10.6364 15.4119 15.4119 10.6364 21.2728 10.6364C27.1337 10.6364 31.9092 15.4119 31.9092 21.2728V25.701H42.5456V21.2728C42.5456 9.50765 33.038 0 21.2728 0C9.50765 0 0.0434132 9.50765 0.0434132 21.2294V42.4588L21.2728 70.7213Z" fill="#3A7BBE"/>
14
+ <path d="M21.2728 70.7213V88H16.2802C14.2832 88 12.4164 87.6527 10.6364 87.0015V70.7213H21.2728Z" fill="#3A7BBE"/>
15
+ <path d="M0.0434139 42.5022L21.2728 70.7647H10.6364V87.0449C4.42822 84.744 0 78.7962 0 71.8066V42.4154V42.5022H0.0434139Z" fill="#3E51A2"/>
16
+ </svg>
17
+
9
18
  </a>
10
19
 
11
- <h3 align="center">Keymaster</h3>
20
+ <h3 align="center">Keymaster</h3>
12
21
 
13
22
  <p align="center">
14
23
  The base styles for all Unlock Projects based off Bootstrap 5
@@ -39,37 +48,43 @@
39
48
  </details>
40
49
 
41
50
  <!-- ABOUT THE PROJECT -->
51
+
42
52
  ## About The Project
43
53
 
44
- Keymaster is the shared visual and interactive language that guides how we build high-quality customer experience. It’s intended for use both internally at Unlock and externally by third-party developers and designers.
54
+ Keymaster is the shared visual and interactive language that guides how we build high-quality customer experience. It’s
55
+ intended for use both internally at Unlock and externally by third-party developers and designers.
45
56
 
46
57
  More specifically, we aim to:
47
- * Make it easier for our customers and partners to do business with us by obscuring organizational boundaries, channels and technology stacks.
58
+
59
+ * Make it easier for our customers and partners to do business with us by obscuring organizational boundaries, channels
60
+ and technology stacks.
48
61
  * Save time and money during the design and delivery phase.
49
62
  * Ease collaboration and align teams.
50
63
 
51
64
  <p align="right">(<a href="#readme-top">back to top</a>)</p>
52
65
 
53
-
54
66
  ### Built With
55
67
 
56
- * [![Bootstrap][Bootstrap.com]][Bootstrap-url]
57
- * [![Storybook][Storybook.js.org]][Storybook-url]
68
+ [![Bootstrap][Bootstrap.com]][Bootstrap-url]
69
+ [![Storybook][Storybook.js.org]][Storybook-url]
58
70
 
59
71
  <p align="right">(<a href="#readme-top">back to top</a>)</p>
60
72
 
61
73
 
62
74
 
63
75
  <!-- GETTING STARTED -->
76
+
64
77
  ## Getting Started
65
78
 
66
79
  ### Prerequisites
67
80
 
68
81
  The design system has a few dependencies that you will need to install before you can use it.
82
+
69
83
  * [Bootstrap 5](https://getbootstrap.com/docs/)
70
84
  * [Sass](https://sass-lang.com/) (Optional: If you want to compile the Sass files yourself.)
71
85
 
72
- Symphony also requires you to have [Bootstrap 5](https://getbootstrap.com/docs/) installed in your project as a peer-dependency.
86
+ Symphony also requires you to have [Bootstrap 5](https://getbootstrap.com/docs/) installed in your project as a
87
+ peer-dependency.
73
88
  If you do not have Bootstrap 5 installed, you can install it with the following command:
74
89
 
75
90
  ```sh
@@ -90,8 +105,8 @@ npm install --save-dev sass
90
105
  npm install -g sass
91
106
  ```
92
107
 
93
-
94
108
  ### Installation
109
+
95
110
  To install `@unlk/keymaster` in your project with [npm](https://www.npmjs.com/), run the following command:
96
111
 
97
112
  ```sh
@@ -103,6 +118,7 @@ npm install @unlk/keymaster
103
118
 
104
119
 
105
120
  <!-- USAGE EXAMPLES -->
121
+
106
122
  ## Usage
107
123
 
108
124
  To use the keymaster design system, you will need to import the scss file into your project.
@@ -128,9 +144,14 @@ import '@unlk/keymaster/js/bootstrap.js';
128
144
 
129
145
  <!-- MARKDOWN LINKS & IMAGES -->
130
146
  <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
147
+
131
148
  [product-screenshot]: images/screenshot.png
149
+
132
150
  [Bootstrap.com]: https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white
151
+
133
152
  [Bootstrap-url]: https://getbootstrap.com
153
+
134
154
  [Storybook.js.org]: https://img.shields.io/badge/Storybook-ff4785?style=for-the-badge&logo=storybook&logoColor=white
155
+
135
156
  [Storybook-url]: https://storybook.js.org/
136
157
 
@@ -1,5 +1,5 @@
1
1
  /*!
2
- * Unlock Keymaster v1.0.3 (https://unlock-com.github.io/keymaster)
2
+ * Unlock Keymaster v1.0.4 (https://unlock-com.github.io/keymaster)
3
3
  * Copyright 2022-2025 Unlk Developers
4
4
  */
5
5
  (function (global, factory) {
@@ -1,5 +1,5 @@
1
1
  /*!
2
- * Unlock Keymaster v1.0.3 (https://unlock-com.github.io/keymaster)
2
+ * Unlock Keymaster v1.0.4 (https://unlock-com.github.io/keymaster)
3
3
  * Copyright 2022-2025 Unlk Developers
4
4
  */
5
5
  !function(t,e){"object"==typeof exports&&"undefined"!=typeof module?e(exports):"function"==typeof define&&define.amd?define(["exports"],e):e((t="undefined"!=typeof globalThis?globalThis:t||self).keymaster={})}(this,(function(t){"use strict";"undefined"!=typeof globalThis?globalThis:"undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof self&&self;function e(t){if(t.__esModule)return t;var e=Object.defineProperty({},"__esModule",{value:!0});return Object.keys(t).forEach((function(i){var n=Object.getOwnPropertyDescriptor(t,i);Object.defineProperty(e,i,n.get?n:{enumerable:!0,get:function(){return t[i]}})})),e}var i={exports:{}},n={exports:{}},s={exports:{}};
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@unlk/keymaster",
3
- "version": "1.0.3",
3
+ "version": "1.0.4",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },
@@ -33,8 +33,7 @@
33
33
  "js",
34
34
  "fonts",
35
35
  "README.md",
36
- "CHANGELOG.md",
37
- "images"
36
+ "CHANGELOG.md"
38
37
  ],
39
38
  "engines": {
40
39
  "node": ">=14"
package/images/unlock.svg DELETED
@@ -1,9 +0,0 @@
1
- <svg width="54" height="88" viewBox="0 0 54 88" fill="none" xmlns="http://www.w3.org/2000/svg">
2
- <path d="M42.5456 70.7213H53.182L31.9092 42.5022H21.2728L42.5456 70.7213Z" fill="#CBEBF8"/>
3
- <path d="M42.5456 70.7213H31.9092V88H42.5456V70.7213Z" fill="#CBEBF8"/>
4
- <path d="M31.9092 70.7213H42.5456L21.2728 42.5022H10.6364L31.9092 70.7213Z" fill="#66CDF3"/>
5
- <path d="M31.9092 70.7213V88H21.2728V70.7213H31.9092Z" fill="#66CDF3"/>
6
- <path d="M21.2728 70.7213H31.9092L10.6364 42.5022V21.2728C10.6364 15.4119 15.4119 10.6364 21.2728 10.6364C27.1337 10.6364 31.9092 15.4119 31.9092 21.2728V25.701H42.5456V21.2728C42.5456 9.50765 33.038 0 21.2728 0C9.50765 0 0.0434132 9.50765 0.0434132 21.2294V42.4588L21.2728 70.7213Z" fill="#3A7BBE"/>
7
- <path d="M21.2728 70.7213V88H16.2802C14.2832 88 12.4164 87.6527 10.6364 87.0015V70.7213H21.2728Z" fill="#3A7BBE"/>
8
- <path d="M0.0434139 42.5022L21.2728 70.7647H10.6364V87.0449C4.42822 84.744 0 78.7962 0 71.8066V42.4154V42.5022H0.0434139Z" fill="#3E51A2"/>
9
- </svg>