@redi.run/redi-components 0.0.46 → 0.0.47

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 +29 -2
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -2,20 +2,20 @@
2
2
 
3
3
  # Redi-Components
4
4
 
5
-
6
5
  [![Latest Release](https://gitlab.redi.run/redi/redi-components/-/badges/release.svg)](https://gitlab.redi.run/redi/redi-components/-/releases)
7
6
 
8
-
9
7
  [![pipeline status](https://gitlab.redi.run/redi/redi-components/badges/main/pipeline.svg)](https://gitlab.redi.run/redi/redi-components/-/commits/main)
10
8
 
11
9
  Small, reusable UI component library for Redi projects.
12
10
 
13
11
  Location
12
+
14
13
  - redi/redi-components
15
14
 
16
15
  This README describes installation, usage, API conventions, development, testing, publishing and contribution guidelines. Replace placeholder examples with concrete component names and props used in this repository.
17
16
 
18
17
  ## Table of contents
18
+
19
19
  - Quick Install
20
20
  - Basic Usage
21
21
  - API reference (how to document each component)
@@ -48,33 +48,40 @@ This README describes installation, usage, API conventions, development, testing
48
48
  - **refactor**: Enhanced TypeScript interfaces in `types.ts`. `rowKey` is now strictly typed, and `selectedRows` no longer uses `any[]`.
49
49
 
50
50
  ## Quick Install
51
+
51
52
  Install from npm or local workspace.
52
53
 
53
54
  npm:
55
+
54
56
  ```bash
55
57
  npm install @redi/redi-components
56
58
  ```
57
59
 
58
60
  yarn:
61
+
59
62
  ```bash
60
63
  yarn add @redi/redi-components
61
64
  ```
62
65
 
63
66
  pnpm:
67
+
64
68
  ```bash
65
69
  pnpm add @redi/redi-components
66
70
  ```
67
71
 
68
72
  Note any peer dependencies (React, Vue, etc.) in package.json and ensure they are installed in the host project:
73
+
69
74
  ```bash
70
75
  # example for React
71
76
  npm install react react-dom
72
77
  ```
73
78
 
74
79
  ## Basic Usage
80
+
75
81
  Provide short usage examples for supported frameworks. Replace with real component names.
76
82
 
77
83
  React (ESM):
84
+
78
85
  ```jsx
79
86
  import React from 'react';
80
87
  import { Button, Card } from '@redi/redi-components';
@@ -93,12 +100,15 @@ function App() {
93
100
  ```
94
101
 
95
102
  TypeScript:
103
+
96
104
  - Types are exported from the package. Example:
105
+
97
106
  ```ts
98
107
  import type { ButtonProps } from '@redi/redi-components';
99
108
  ```
100
109
 
101
110
  Vanilla (if UMD build available):
111
+
102
112
  ```html
103
113
  <script src="redi-components.umd.js"></script>
104
114
  <script>
@@ -108,7 +118,9 @@ Vanilla (if UMD build available):
108
118
  ```
109
119
 
110
120
  ## API Reference (how to document each component)
121
+
111
122
  For each component include:
123
+
112
124
  - Name and purpose
113
125
  - Import path
114
126
  - Props / attributes (name, type, default, description)
@@ -118,6 +130,7 @@ For each component include:
118
130
  - CSS variables / classnames
119
131
 
120
132
  Template:
133
+
121
134
  ```md
122
135
  ### ComponentName
123
136
  Description.
@@ -128,13 +141,16 @@ import { ComponentName } from '@redi/redi-components';
128
141
  ```
129
142
 
130
143
  Props:
144
+
131
145
  - propName: type — default — description
132
146
  - onEvent: (event) => void — — description
133
147
 
134
148
  Example:
149
+
135
150
  ```jsx
136
151
  <ComponentName propName="value" onEvent={(e) => {}} />
137
152
  ```
153
+
138
154
  ```
139
155
 
140
156
  ## Theming & Styling
@@ -153,13 +169,16 @@ Example (CSS variables):
153
169
  ```
154
170
 
155
171
  ## Accessibility
172
+
156
173
  - Components must follow WCAG standards.
157
174
  - Keyboard interactions documented per component.
158
175
  - Use semantic HTML elements and ARIA attributes where necessary.
159
176
  - Provide examples of screen-reader usage.
160
177
 
161
178
  ## Development
179
+
162
180
  Recommended project structure:
181
+
163
182
  ```
164
183
  /src
165
184
  /components
@@ -171,6 +190,7 @@ Recommended project structure:
171
190
  ```
172
191
 
173
192
  Scripts (examples in package.json):
193
+
174
194
  ```json
175
195
  {
176
196
  "build": "tsc && rollup -c",
@@ -182,11 +202,13 @@ Scripts (examples in package.json):
182
202
  ```
183
203
 
184
204
  Tips:
205
+
185
206
  - Use TypeScript and export types.
186
207
  - Use Storybook or a docs site for live component examples.
187
208
  - Keep components composable and documented.
188
209
 
189
210
  ## Testing & CI
211
+
190
212
  - Unit tests: Jest/Vitest + Testing Library for DOM tests.
191
213
  - Snapshot tests for API stability.
192
214
  - Accessibility tests using axe-core.
@@ -198,25 +220,30 @@ Tips:
198
220
  - publish (on tags)
199
221
 
200
222
  ## Publishing
223
+
201
224
  - Use semantic-release or manual versioning.
202
225
  - Build artifacts: ESM, CJS, UMD (optional), and type declarations (.d.ts).
203
226
  - Ensure package.json fields: main, module, types, files, sideEffects.
204
227
  - Set up CHANGELOG.md and follow Conventional Commits for automation.
205
228
 
206
229
  ## Contributing
230
+
207
231
  - Fork -> branch -> PR.
208
232
  - Follow commit message guidelines (Conventional Commits).
209
233
  - Run tests and linters before PR.
210
234
  - Include documentation and examples for new components or breaking changes.
211
235
 
212
236
  ## Changelog & Versioning
237
+
213
238
  - Follow semantic versioning (MAJOR.MINOR.PATCH).
214
239
  - Maintain CHANGELOG.md with notable changes per release.
215
240
 
216
241
  ## License
242
+
217
243
  - Add license file (e.g., MIT) and reference in package.json.
218
244
 
219
245
  ## Contact / Maintainers
246
+
220
247
  - Provide maintainer names and preferred contact (email or GitHub handles).
221
248
 
222
249
  ---
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@redi.run/redi-components",
3
3
  "description": "This project was created to define the style of the UI and improve the UX in all projects from REDI",
4
- "version": "0.0.46",
4
+ "version": "0.0.47",
5
5
  "type": "module",
6
6
  "author": {
7
7
  "name": "Jonathan Manchego Sosa",