@smitch/breeze 0.2.3 → 1.1.0

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 +87 -92
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,8 +1,8 @@
1
- # Fluid UI
1
+ # Breeze UI
2
2
 
3
3
  A Next.js/React UI component library.
4
4
 
5
- - [Fluid UI](#fluid-ui)
5
+ - [Breeze UI](#breeze-ui)
6
6
  - [Overview](#overview)
7
7
  - [Features](#features)
8
8
  - [Getting Started](#getting-started)
@@ -38,7 +38,7 @@ A Next.js/React UI component library.
38
38
 
39
39
  ## Overview
40
40
 
41
- Fluid UI is a comprehensive library of reusable UI components for Next.js/React applications. This
41
+ Breeze UI is a comprehensive library of reusable UI components for Next.js/React applications. This
42
42
  library is designed to streamline the development process and ensure consistency across projects.
43
43
 
44
44
  ## Features
@@ -50,7 +50,7 @@ library is designed to streamline the development process and ensure consistency
50
50
 
51
51
  ## Getting Started
52
52
 
53
- To use Fluid UI in your Next.js/React project, follow these steps:
53
+ To use Breeze UI in your Next.js/React project, follow these steps:
54
54
 
55
55
  ### 1. Install Next.js and React
56
56
 
@@ -70,10 +70,10 @@ including `tsconfig.json`, `tailwind.config.js`, and PostCSS setup.
70
70
 
71
71
  ### 2. Configure Tailwind 3
72
72
 
73
- To ensure that **Fluid UI** works correctly, you need to configure **TailwindCSS**. Follow the steps
74
- below:
73
+ To ensure that **Breeze UI** works correctly, you need to configure **TailwindCSS**. Follow the
74
+ steps below:
75
75
 
76
- Note: All current Fluid releases utilize TailwindCSS v3.
76
+ Note: All current Breeze releases utilize TailwindCSS v3.
77
77
 
78
78
  #### 2. Configure `tailwind.config.js`
79
79
 
@@ -92,7 +92,7 @@ const config: Config = {
92
92
  "./src/components/**/*.{js,ts,jsx,tsx,mdx}",
93
93
  "./src/app/**/*.{js,ts,jsx,tsx,mdx}",
94
94
  /* IMPORTANT: Add this line: */
95
- "./node_modules/@smitch/fluid/**/*.js",
95
+ "./node_modules/@smitch/Breeze/**/*.js",
96
96
  ],
97
97
  theme: {
98
98
  extend: {
@@ -159,28 +159,28 @@ export default config;
159
159
  ## Installation
160
160
 
161
161
  ```bash
162
- npm install @smitch/fluid
162
+ npm install @smitch/breeze
163
163
  ```
164
164
 
165
165
  ## Compatibility
166
166
 
167
167
  ### Supported stacks & compatibility matrix
168
168
 
169
- Use the table below to pick the Fluid major line that matches your app's React / Next.js and
169
+ Use the table below to pick the Breeze major line that matches your app's React / Next.js and
170
170
  Tailwind versions. This helps avoid peer dependency conflicts.
171
171
 
172
- - Fluid v4.x (current):
172
+ - Breeze v4.x (current):
173
173
 
174
174
  - React: 19.x
175
175
  - Next.js: 15.x
176
176
  - Tailwind: 3.x
177
- - Install: `npm install @smitch/fluid`
177
+ - Install: `npm install @smitch/breeze`
178
178
 
179
- - Fluid v3.x:
179
+ - Breeze v3.x:
180
180
  - React: 18.x
181
181
  - Next.js: 14.x (and other releases built on React 18)
182
182
  - Tailwind: 3.x
183
- - Install: `npm install @smitch/fluid@^3`
183
+ - Install: `npm install @smitch/Breeze@^3`
184
184
 
185
185
  ### Node / environment
186
186
 
@@ -193,8 +193,8 @@ Tailwind versions. This helps avoid peer dependency conflicts.
193
193
 
194
194
  ## Peer dependencies
195
195
 
196
- Fluid is a component library and expects the host app to provide framework/runtime dependencies.
197
- Below are the packages you should have installed in your project when using `@smitch/fluid`.
196
+ Breeze is a component library and expects the host app to provide framework/runtime dependencies.
197
+ Below are the packages you should have installed in your project when using `@smitch/Breeze`.
198
198
 
199
199
  Required (framework)
200
200
 
@@ -231,10 +231,10 @@ npm install -D @types/leaflet
231
231
 
232
232
  ## Basic Usage
233
233
 
234
- Now, you can import and use any Fluid UI [component](#components) in your Next.js project:
234
+ Now, you can import and use any Breeze UI [component](#components) in your Next.js project:
235
235
 
236
236
  ```jsx
237
- import { Button } from "@smitch/fluid";
237
+ import { Button } from "@smitch/Breeze";
238
238
 
239
239
  const App = () => <Button>Click me</Button>;
240
240
 
@@ -264,7 +264,7 @@ npm install chart.js react-chartjs-2
264
264
  ### Chart Usage Example
265
265
 
266
266
  ```jsx
267
- import { BarChart } from "@smitch/fluid/charts";
267
+ import { BarChart } from "@smitch/Breeze/charts";
268
268
 
269
269
  const App = () => {
270
270
  return (
@@ -321,7 +321,7 @@ npm install -D @types/leaflet @types/leaflet.fullscreen
321
321
  #### Static Map
322
322
 
323
323
  ```jsx
324
- import { Map } from "@smitch/fluid/map";
324
+ import { Map } from "@smitch/Breeze/map";
325
325
 
326
326
  const App = () => {
327
327
  return (
@@ -343,7 +343,7 @@ export default App;
343
343
  #### Map with marker
344
344
 
345
345
  ```jsx
346
- import { Map, MapMarker } from "@smitch/fluid/map";
346
+ import { Map, MapMarker } from "@smitch/Breeze/map";
347
347
 
348
348
  const App = () => {
349
349
  return (
@@ -373,113 +373,108 @@ export default App;
373
373
 
374
374
  ### Buttons
375
375
 
376
- - <a href='https://fluid-ui.vercel.app/?path=/docs/buttons-button--docs'>Button</a>
377
- - <a href='https://fluid-ui.vercel.app/?path=/docs/buttons-button-close-button--docs'>Close
378
- Button</a>
379
- - <a href='https://fluid-ui.vercel.app/?path=/docs/buttons-button-group--docs'>Button Group</a>
376
+ - <a href='https://breezeui.site/?path=/docs/buttons-button--docs'>Button</a>
377
+ - <a href='https://breezeui.site/?path=/docs/buttons-button-close-button--docs'>Close Button</a>
378
+ - <a href='https://breezeui.site/?path=/docs/buttons-button-group--docs'>Button Group</a>
380
379
 
381
380
  ### Inputs
382
381
 
383
- - <a href='https://fluid-ui.vercel.app/?path=/docs/inputs-autocomplete--docs'>
382
+ - <a href='https://breezeui.site/?path=/docs/inputs-autocomplete--docs'>
384
383
  Autocomplete
385
384
  </a>
386
- - <a href='https://fluid-ui.vercel.app/?path=/docs/inputs-checkbox--docs'>Checkbox</a>
387
- - <a href='https://fluid-ui.vercel.app/?path=/docs/inputs-counter--docs'>Counter</a>
388
- - <a href='https://fluid-ui.vercel.app/?path=/docs/inputs-file-upload--docs'>File Upload</a>
389
- - <a href='https://fluid-ui.vercel.app/?path=/docs/inputs-input--docs'>Input</a>
390
- - <a href='https://fluid-ui.vercel.app/?path=/docs/inputs-password-input--docs'>Password Input</a>
391
- - <a href='https://fluid-ui.vercel.app/?path=/docs/inputs-radiog-roup--docs'>Radio Group</a>
392
- - <a href='https://fluid-ui.vercel.app/?path=/docs/inputs-range-input--docs'>Range Input</a>
393
- - <a href='https://fluid-ui.vercel.app/?path=/docs/inputs-search-input--docs'>Search Input</a>
394
- - <a href='https://fluid-ui.vercel.app/?path=/docs/inputs-select--docs'>Select</a>
395
- - <a href='https://fluid-ui.vercel.app/?path=/docs/inputs-switch--docs'>Switch</a>
396
- - <a href='https://fluid-ui.vercel.app/?path=/docs/inputs-textarea--docs'>Textarea</a>
397
- - <a href='https://fluid-ui.vercel.app/?path=/docs/inputs-text-input--docs'>Text Input</a>
385
+ - <a href='https://breezeui.site/?path=/docs/inputs-checkbox--docs'>Checkbox</a>
386
+ - <a href='https://breezeui.site/?path=/docs/inputs-counter--docs'>Counter</a>
387
+ - <a href='https://breezeui.site/?path=/docs/inputs-file-upload--docs'>File Upload</a>
388
+ - <a href='https://breezeui.site/?path=/docs/inputs-input--docs'>Input</a>
389
+ - <a href='https://breezeui.site/?path=/docs/inputs-password-input--docs'>Password Input</a>
390
+ - <a href='https://breezeui.site/?path=/docs/inputs-radiog-roup--docs'>Radio Group</a>
391
+ - <a href='https://breezeui.site/?path=/docs/inputs-range-input--docs'>Range Input</a>
392
+ - <a href='https://breezeui.site/?path=/docs/inputs-search-input--docs'>Search Input</a>
393
+ - <a href='https://breezeui.site/?path=/docs/inputs-select--docs'>Select</a>
394
+ - <a href='https://breezeui.site/?path=/docs/inputs-switch--docs'>Switch</a>
395
+ - <a href='https://breezeui.site/?path=/docs/inputs-textarea--docs'>Textarea</a>
396
+ - <a href='https://breezeui.site/?path=/docs/inputs-text-input--docs'>Text Input</a>
398
397
 
399
398
  ### Forms
400
399
 
401
- - <a href='https://fluid-ui.vercel.app/?path=/docs/forms-fieldset--docs'>Fieldset</a>
402
- - <a href='https://fluid-ui.vercel.app/?path=/docs/forms-form--docs'>Form</a>
403
- - <a href='https://fluid-ui.vercel.app/?path=/docs/forms-label--docs'>Label</a>
400
+ - <a href='https://breezeui.site/?path=/docs/forms-fieldset--docs'>Fieldset</a>
401
+ - <a href='https://breezeui.site/?path=/docs/forms-form--docs'>Form</a>
402
+ - <a href='https://breezeui.site/?path=/docs/forms-label--docs'>Label</a>
404
403
 
405
404
  ### Menus
406
405
 
407
- - <a href='https://fluid-ui.vercel.app/?path=/docs/menus-accordion--docs'>Accordion</a>
408
- - <a href='https://fluid-ui.vercel.app/?path=/docs/menus-breadcrumbs--docs'>Breadcrumbs</a>
409
- - <a href='https://fluid-ui.vercel.app/?path=/docs/menus-carousel--docs'>Carousel</a>
410
- - <a href='https://fluid-ui.vercel.app/?path=/docs/menus-drawer--docs'>Drawer</a>
411
- - <a href='https://fluid-ui.vercel.app/?path=/docs/menus-dropdown--docs'>Dropdown</a>
412
- - <a href='https://fluid-ui.vercel.app/?path=/docs/menus-navbar--docs'>NavBar</a>
413
- - <a href='https://fluid-ui.vercel.app/?path=/docs/menus-pagination--docs'>Pagination</a>
414
- - <a href='https://fluid-ui.vercel.app/?path=/docs/menus-sidebar--docs'>Sidebar</a>
415
- - <a href='https://fluid-ui.vercel.app/?path=/docs/menus-tabs--docs'>Tabs</a>
406
+ - <a href='https://breezeui.site/?path=/docs/menus-accordion--docs'>Accordion</a>
407
+ - <a href='https://breezeui.site/?path=/docs/menus-breadcrumbs--docs'>Breadcrumbs</a>
408
+ - <a href='https://breezeui.site/?path=/docs/menus-carousel--docs'>Carousel</a>
409
+ - <a href='https://breezeui.site/?path=/docs/menus-drawer--docs'>Drawer</a>
410
+ - <a href='https://breezeui.site/?path=/docs/menus-dropdown--docs'>Dropdown</a>
411
+ - <a href='https://breezeui.site/?path=/docs/menus-navbar--docs'>NavBar</a>
412
+ - <a href='https://breezeui.site/?path=/docs/menus-pagination--docs'>Pagination</a>
413
+ - <a href='https://breezeui.site/?path=/docs/menus-sidebar--docs'>Sidebar</a>
414
+ - <a href='https://breezeui.site/?path=/docs/menus-tabs--docs'>Tabs</a>
416
415
 
417
416
  ### Feedback
418
417
 
419
- - <a href='https://fluid-ui.vercel.app/?path=/docs/feedback-alert--docs'>Alert</a>
420
- - <a href='https://fluid-ui.vercel.app/?path=/docs/feedback-badge--docs'>Badge</a>
421
- - <a href='https://fluid-ui.vercel.app/?path=/docs/feedback-dialog--docs'>Dialog</a>
422
- - <a href='https://fluid-ui.vercel.app/?path=/docs/feedback-loading--docs'>Loading</a>
423
- - <a href='https://fluid-ui.vercel.app/?path=/docs/feedback-progress--docs'>Progress</a>
424
- - <a href='https://fluid-ui.vercel.app/?path=/docs/feedback-ratings--docs'>Ratings</a>
425
- - <a href='https://fluid-ui.vercel.app/?path=/docs/feedback-ticker--docs'>Ticker</a>
426
- - <a href='https://fluid-ui.vercel.app/?path=/docs/feedback-toast--docs'>Toast</a>
418
+ - <a href='https://breezeui.site/?path=/docs/feedback-alert--docs'>Alert</a>
419
+ - <a href='https://breezeui.site/?path=/docs/feedback-badge--docs'>Badge</a>
420
+ - <a href='https://breezeui.site/?path=/docs/feedback-dialog--docs'>Dialog</a>
421
+ - <a href='https://breezeui.site/?path=/docs/feedback-loading--docs'>Loading</a>
422
+ - <a href='https://breezeui.site/?path=/docs/feedback-progress--docs'>Progress</a>
423
+ - <a href='https://breezeui.site/?path=/docs/feedback-ratings--docs'>Ratings</a>
424
+ - <a href='https://breezeui.site/?path=/docs/feedback-ticker--docs'>Ticker</a>
425
+ - <a href='https://breezeui.site/?path=/docs/feedback-toast--docs'>Toast</a>
427
426
 
428
427
  ### Media
429
428
 
430
- - <a href='https://fluid-ui.vercel.app/?path=/docs/media-card--docs'>Card</a>
431
- - <a href='https://fluid-ui.vercel.app/?path=/docs/media-figure--docs'>Figure</a>
432
- - <a href='https://fluid-ui.vercel.app/?path=/docs/media-gallery--docs'>Gallery</a>
433
- - <a href='https://fluid-ui.vercel.app/?path=/docs/media-hero--docs'>Hero</a>
434
- - <a href='https://fluid-ui.vercel.app/?path=/docs/media-icon--docs'>Icon</a>
435
- - <a href='https://fluid-ui.vercel.app/?path=/docs/media-modal--docs'>Modal</a>
436
- - <a href='https://fluid-ui.vercel.app/?path=/docs/media-placeholder--docs'>PlaceHolder</a>
437
- - <a href='https://fluid-ui.vercel.app/?path=/docs/media-twitter-embed--docs'>Twitter Embed</a>
438
- - <a href='https://fluid-ui.vercel.app/?path=/docs/media-twitter-embed--docs'>Twitter Timeline</a>
439
- - <a href='https://fluid-ui.vercel.app/?path=/docs/media-video--docs'>Video</a>
440
- - <a href='https://fluid-ui.vercel.app/?path=/docs/media-video-player--docs'>Video Player</a>
441
- - <a href='https://fluid-ui.vercel.app/?path=/docs/media-youtube-embed--docs'>YouTube Embed</a>
429
+ - <a href='https://breezeui.site/?path=/docs/media-card--docs'>Card</a>
430
+ - <a href='https://breezeui.site/?path=/docs/media-figure--docs'>Figure</a>
431
+ - <a href='https://breezeui.site/?path=/docs/media-gallery--docs'>Gallery</a>
432
+ - <a href='https://breezeui.site/?path=/docs/media-hero--docs'>Hero</a>
433
+ - <a href='https://breezeui.site/?path=/docs/media-icon--docs'>Icon</a>
434
+ - <a href='https://breezeui.site/?path=/docs/media-modal--docs'>Modal</a>
435
+ - <a href='https://breezeui.site/?path=/docs/media-placeholder--docs'>PlaceHolder</a>
436
+ - <a href='https://breezeui.site/?path=/docs/media-twitter-embed--docs'>Twitter Embed</a>
437
+ - <a href='https://breezeui.site/?path=/docs/media-twitter-embed--docs'>Twitter Timeline</a>
438
+ - <a href='https://breezeui.site/?path=/docs/media-video--docs'>Video</a>
439
+ - <a href='https://breezeui.site/?path=/docs/media-video-player--docs'>Video Player</a>
440
+ - <a href='https://breezeui.site/?path=/docs/media-youtube-embed--docs'>YouTube Embed</a>
442
441
 
443
442
  ### Typography
444
443
 
445
- - <a href='https://fluid-ui.vercel.app/?path=/docs/typography-blockquote--docs'>Blockquote</a>
446
- - <a href='https://fluid-ui.vercel.app/?path=/docs/typography-codeblock--docs'>Codeblock</a>
447
- - <a href='https://fluid-ui.vercel.app/?path=/docs/typography-heading--docs'>Heading</a>
444
+ - <a href='https://breezeui.site/?path=/docs/typography-blockquote--docs'>Blockquote</a>
445
+ - <a href='https://breezeui.site/?path=/docs/typography-codeblock--docs'>Codeblock</a>
446
+ - <a href='https://breezeui.site/?path=/docs/typography-heading--docs'>Heading</a>
448
447
 
449
448
  ### Data Visualization
450
449
 
451
- - <a href='https://fluid-ui.vercel.app/?path=/docs/data-visualization-data-table--docs'>Data
452
- Table</a>
453
- - <a href='https://fluid-ui.vercel.app/?path=/docs/data-visualization-pictogram--docs'>Pictogram</a>
454
- - <a href='https://fluid-ui.vercel.app/?path=/docs/data-visualization-line-chart--docs'>Line
450
+ - <a href='https://breezeui.site/?path=/docs/data-visualization-data-table--docs'>Data Table</a>
451
+ - <a href='https://breezeui.site/?path=/docs/data-visualization-pictogram--docs'>Pictogram</a>
452
+ - <a href='https://breezeui.site/?path=/docs/data-visualization-line-chart--docs'>Line Chart</a>
453
+ - <a href='https://breezeui.site/?path=/docs/data-visualization-bar-chart--docs'>Bar Chart</a>
454
+ - <a href='https://breezeui.site/?path=/docs/data-visualization-mixed-chart--docs'>Mixed Chart</a>
455
+ - <a href='https://breezeui.site/?path=/docs/data-visualization-pie-chart--docs'>Pie Chart</a>
456
+ - <a href='https://breezeui.site/?path=/docs/data-visualization-doughnut-chart--docs'>Doughnut
455
457
  Chart</a>
456
- - <a href='https://fluid-ui.vercel.app/?path=/docs/data-visualization-bar-chart--docs'>Bar Chart</a>
457
- - <a href='https://fluid-ui.vercel.app/?path=/docs/data-visualization-mixed-chart--docs'>Mixed
458
+ - <a href='https://breezeui.site/?path=/docs/data-visualization-radar-chart--docs'>Radar Chart</a>
459
+ - <a href='https://breezeui.site/?path=/docs/data-visualization-polar-area-chart--docs'>PolarArea
458
460
  Chart</a>
459
- - <a href='https://fluid-ui.vercel.app/?path=/docs/data-visualization-pie-chart--docs'>Pie Chart</a>
460
- - <a href='https://fluid-ui.vercel.app/?path=/docs/data-visualization-doughnut-chart--docs'>Doughnut
461
+ - <a href='https://breezeui.site/?path=/docs/data-visualization-scatter-chart--docs'>Scatter
461
462
  Chart</a>
462
- - <a href='https://fluid-ui.vercel.app/?path=/docs/data-visualization-radar-chart--docs'>Radar
463
- Chart</a>
464
- - <a href='https://fluid-ui.vercel.app/?path=/docs/data-visualization-polar-area-chart--docs'>PolarArea
465
- Chart</a>
466
- - <a href='https://fluid-ui.vercel.app/?path=/docs/data-visualization-scatter-chart--docs'>Scatter
467
- Chart</a>
468
- - <a href='https://fluid-ui.vercel.app/?path=/docs/data-visualization-stat-bar--docs'>Stat Bar</a>
463
+ - <a href='https://breezeui.site/?path=/docs/data-visualization-stat-bar--docs'>Stat Bar</a>
469
464
 
470
465
  ### Time
471
466
 
472
- - <a href='https://fluid-ui.vercel.app/?path=/docs/time-clock--docs'>Clock</a>
467
+ - <a href='https://breezeui.site/?path=/docs/time-clock--docs'>Clock</a>
473
468
 
474
469
  ### Maps
475
470
 
476
- - <a href='https://fluid-ui.vercel.app/?path=/docs/maps-map--docs'>Map</a>
471
+ - <a href='https://breezeui.site/?path=/docs/maps-map--docs'>Map</a>
477
472
 
478
473
  ### Social Media
479
474
 
480
- - <a href='https://fluid-ui.vercel.app/?path=/docs/social-socialshare--docs'>Social Media Share</a>
475
+ - <a href='https://breezeui.site/?path=/docs/social-socialshare--docs'>Social Media Share</a>
481
476
 
482
477
  ## Author
483
478
 
484
- Fluid UI is developed and maintained by
479
+ Breeze UI is developed and maintained by
485
480
  [Stephen Mitchell](https://www.linkedin.com/in/stephen-m-52a3a4192).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@smitch/breeze",
3
- "version": "0.2.3",
3
+ "version": "1.1.0",
4
4
  "description": "A lightweight, Tailwind-powered React/Next.js UI component library.",
5
5
  "main": "index.js",
6
6
  "keywords": [