@adiba-banking-cloud/backoffice 0.0.95 → 0.0.96

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 (2) hide show
  1. package/README.md +23 -8
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -15,6 +15,7 @@ A React component library for building modern backoffice applications. This libr
15
15
  ## Components
16
16
 
17
17
  ### Charts
18
+
18
19
  - **Area Charts**: Interactive area charts with customizable colors and gradients
19
20
  - **Column Charts**: Bar and column charts with rounded corners and customizable styling
20
21
  - **Donut Charts**: Circular charts with customizable inner radius and labels
@@ -30,13 +31,15 @@ A React component library for building modern backoffice applications. This libr
30
31
  - Customizable grid lines and labels
31
32
 
32
33
  ### Drag and Drop
33
- - **Kanban Board**:
34
+
35
+ - **Kanban Board**:
34
36
  - Drag and drop columns and cards
35
37
  - Customizable card content
36
38
  - Column reordering
37
39
  - Card status management
38
40
 
39
41
  ### Menus
42
+
40
43
  - **Side Navigation**:
41
44
  - Collapsible sidebar
42
45
  - Nested menu items
@@ -73,6 +76,7 @@ npm install @mantine/core@^7.12.2 @mantine/hooks@^7.12.2 @hello-pangea/dnd@^16.5
73
76
  ```
74
77
 
75
78
  Or install everything at once:
79
+
76
80
  ```bash
77
81
  npm install backoffice-console-library react@^18.3.1 @mantine/core@^7.12.2 @mantine/hooks@^7.12.2 @hello-pangea/dnd@^16.5.0 highcharts-react-official@^3.2.2 highcharts-rounded-corners@^1.0.7 iconsax-react@^0.0.8 @fontsource/poppins@^5.1.0
78
82
  ```
@@ -84,14 +88,10 @@ This library requires React 18.3.1 or higher as a peer dependency.
84
88
  ## Usage
85
89
 
86
90
  ```tsx
87
- import { ComponentName } from 'backoffice-console-library';
91
+ import { ComponentName } from "backoffice-console-library";
88
92
 
89
93
  function App() {
90
- return (
91
- <ComponentName>
92
- {/* Your content here */}
93
- </ComponentName>
94
- );
94
+ return <ComponentName>{/* Your content here */}</ComponentName>;
95
95
  }
96
96
  ```
97
97
 
@@ -106,6 +106,7 @@ function App() {
106
106
 
107
107
  1. Clone the repository
108
108
  2. Install dependencies:
109
+
109
110
  ```bash
110
111
  npm install
111
112
  ```
@@ -128,6 +129,7 @@ npm install
128
129
  ## Publishing to npm
129
130
 
130
131
  ### Prerequisites
132
+
131
133
  1. An npm account (create one at https://www.npmjs.com/signup)
132
134
  2. npm CLI installed globally (`npm install -g npm`)
133
135
  3. Logged in to npm (`npm login`)
@@ -135,6 +137,7 @@ npm install
135
137
  ### Publishing Steps
136
138
 
137
139
  1. **Prepare Your Package**
140
+
138
141
  ```bash
139
142
  # Ensure all changes are committed
140
143
  git add .
@@ -142,12 +145,14 @@ npm install
142
145
  ```
143
146
 
144
147
  2. **Build the Package**
148
+
145
149
  ```bash
146
150
  # Build the library
147
151
  npm run rollup
148
152
  ```
149
153
 
150
154
  3. **Update Version**
155
+
151
156
  ```bash
152
157
  # Update version (patch, minor, or major)
153
158
  npm version patch # for bug fixes
@@ -163,23 +168,30 @@ npm install
163
168
  ```
164
169
 
165
170
  ### Automated Publishing
171
+
166
172
  The package includes a deploy script that automates the publishing process:
173
+
167
174
  ```bash
168
175
  npm run deploy
169
176
  ```
177
+
170
178
  This script will:
179
+
171
180
  1. Stage and commit changes
172
181
  2. Build the library
173
182
  3. Increment the patch version
174
183
  4. Publish to npm
175
184
 
176
185
  ### Version Management
186
+
177
187
  - Use `npm version patch` for bug fixes (1.0.x)
178
188
  - Use `npm version minor` for new features (1.x.0)
179
189
  - Use `npm version major` for breaking changes (x.0.0)
180
190
 
181
191
  ### Publishing Checklist
192
+
182
193
  Before publishing, ensure:
194
+
183
195
  1. All tests pass
184
196
  2. Documentation is up to date
185
197
  3. Version number is correct
@@ -188,6 +200,7 @@ Before publishing, ensure:
188
200
  6. No sensitive information is included
189
201
 
190
202
  ### Troubleshooting
203
+
191
204
  - If you get a 403 error, ensure you're logged in (`npm login`)
192
205
  - If you get a 404 error, check if the package name is available
193
206
  - If you get a version conflict, ensure you're not trying to publish an existing version
@@ -207,6 +220,7 @@ backoffice-console-library/
207
220
  ## Dependencies
208
221
 
209
222
  ### Required Dependencies
223
+
210
224
  - `react` (^18.3.1) - Peer dependency
211
225
  - `@mantine/core` (^7.12.2) - UI framework
212
226
  - `@mantine/hooks` (^7.12.2) - UI hooks
@@ -217,6 +231,7 @@ backoffice-console-library/
217
231
  - `@fontsource/poppins` (^5.1.0) - Font family
218
232
 
219
233
  ### Development Dependencies
234
+
220
235
  - `typescript` (^5.6.2) - TypeScript support
221
236
  - `rollup` (^3.29.5) - Module bundler
222
237
  - `@rollup/plugin-typescript` (^11.1.6) - TypeScript plugin for Rollup
@@ -244,4 +259,4 @@ This project is licensed under the ISC License.
244
259
 
245
260
  ## Support
246
261
 
247
- For support, please open an issue in the repository.
262
+ For support, please open an issue in the repository.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@adiba-banking-cloud/backoffice",
3
3
  "author": "TUROG Technologies",
4
- "version": "0.0.95",
4
+ "version": "0.0.96",
5
5
  "description": "An ADIBA component library for backoffice and dashboard applications",
6
6
  "license": "ISC",
7
7
  "main": "build/index.cjs.js",