smooth-components 1.1.4 β 1.1.6
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/LICENSE +21 -0
- package/README.md +102 -1
- package/package.json +17 -3
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 Jaime Torres
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1 +1,102 @@
|
|
|
1
|
-
|
|
1
|
+
# π¦ smooth-components
|
|
2
|
+
|
|
3
|
+
**Elegant, customizable, and accessible React components.**
|
|
4
|
+
|
|
5
|
+
`smooth-components` is a growing library of beautifully designed, reusable UI components for React. Whether you're building a portfolio, dashboard, or e-commerce site, these components help you move fast and look greatβwithout sacrificing accessibility or flexibility.
|
|
6
|
+
|
|
7
|
+
[](https://www.npmjs.com/package/smooth-components)
|
|
8
|
+
[](https://opensource.org/licenses/MIT)
|
|
9
|
+
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
## π Installation
|
|
13
|
+
|
|
14
|
+
Install via **npm** or **yarn**:
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
npm install smooth-components
|
|
18
|
+
# or
|
|
19
|
+
yarn add smooth-components
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
---
|
|
23
|
+
|
|
24
|
+
## πΌοΈ Poster Component
|
|
25
|
+
|
|
26
|
+
The `Poster` component is ideal for showcasing images like movie posters, artworks, product covers, or any visual element that needs emphasis. It includes styling options for borders, size, opacity, and an optional animated **glint** effect.
|
|
27
|
+
|
|
28
|
+
### β
Example Usage
|
|
29
|
+
|
|
30
|
+
```tsx
|
|
31
|
+
import { Poster } from 'smooth-components'
|
|
32
|
+
|
|
33
|
+
export default function App() {
|
|
34
|
+
return (
|
|
35
|
+
<Poster
|
|
36
|
+
alt="Cyberpunk City"
|
|
37
|
+
src="/images/cyberpunk.jpg"
|
|
38
|
+
styles={{
|
|
39
|
+
width: 240,
|
|
40
|
+
height: 360,
|
|
41
|
+
borderColor: '#555',
|
|
42
|
+
opacity: 0.95,
|
|
43
|
+
}}
|
|
44
|
+
/>
|
|
45
|
+
)
|
|
46
|
+
}
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
---
|
|
50
|
+
|
|
51
|
+
### π§ Props
|
|
52
|
+
|
|
53
|
+
| Prop | Type | Default | Description |
|
|
54
|
+
| -------------------- | ------------------ | ------------------------------ | --------------------------------------------------------- |
|
|
55
|
+
| `alt` | `string` | β | Descriptive alt text for accessibility. |
|
|
56
|
+
| `src` | `string` | β | Path or URL to the image. |
|
|
57
|
+
| `styles` | `object` | β | Optional custom styles for the container. |
|
|
58
|
+
| `styles.opacity` | `number \| string` | `0.91` | Opacity of the image container. |
|
|
59
|
+
| `styles.width` | `number \| string` | `'auto'` | Width of the image container. |
|
|
60
|
+
| `styles.height` | `number \| string` | `'auto'` | Height of the image container. |
|
|
61
|
+
| `styles.borderColor` | `string` | `'oklch(12.9% 0.042 264.695)'` | Color of the border around the poster. |
|
|
62
|
+
| `hasGlintEffect` | `boolean` | `true` | Enables a subtle animated glint overlay across the image. |
|
|
63
|
+
|
|
64
|
+
> π‘ You can use numbers (interpreted as `px`) or standard CSS units (`px`, `%`, `em`, etc.) for style values. The `glint` effect adds a stylish shimmer animation for extra polish.
|
|
65
|
+
|
|
66
|
+
---
|
|
67
|
+
|
|
68
|
+
## 𧩠More Components Coming Soon
|
|
69
|
+
|
|
70
|
+
This is just the beginning. Stay tuned for new additions including:
|
|
71
|
+
|
|
72
|
+
* Modals
|
|
73
|
+
* Cards
|
|
74
|
+
* Loaders
|
|
75
|
+
* And more...
|
|
76
|
+
|
|
77
|
+
---
|
|
78
|
+
|
|
79
|
+
## π License
|
|
80
|
+
|
|
81
|
+
MIT Β© [Jaime Torres](https://github.com/jaime00)
|
|
82
|
+
See the full license in [LICENSE](./LICENSE).
|
|
83
|
+
|
|
84
|
+
---
|
|
85
|
+
|
|
86
|
+
## π¬ Connect with Me
|
|
87
|
+
|
|
88
|
+
* π [Portfolio](https://jaime00portfolio.netlify.app/)
|
|
89
|
+
* πΌ [LinkedIn](https://www.linkedin.com/in/jaime00)
|
|
90
|
+
* π§ [Email](mailto:imjaimetorresv@gmail.com)
|
|
91
|
+
* π [GitHub](https://github.com/jaime00)
|
|
92
|
+
|
|
93
|
+
---
|
|
94
|
+
|
|
95
|
+
Let me know if youβd like to add:
|
|
96
|
+
|
|
97
|
+
* Usage with Tailwind or a specific framework
|
|
98
|
+
* Storybook/preview link
|
|
99
|
+
* Development & contribution guide
|
|
100
|
+
* More animated gifs/screenshots
|
|
101
|
+
|
|
102
|
+
Want me to help generate a demo GIF or improve visuals? Happy to assist.
|
package/package.json
CHANGED
|
@@ -1,8 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "smooth-components",
|
|
3
|
-
"description": "A collection of smooth and elegant React components for building modern web applications
|
|
4
|
-
"version": "1.1.
|
|
3
|
+
"description": "A collection of smooth and elegant React components for building modern web applications.",
|
|
4
|
+
"version": "1.1.6",
|
|
5
5
|
"type": "module",
|
|
6
|
+
"author": "Jaime Torres",
|
|
7
|
+
"license": "MIT",
|
|
6
8
|
"files": [
|
|
7
9
|
"dist"
|
|
8
10
|
],
|
|
@@ -41,5 +43,17 @@
|
|
|
41
43
|
"vite": "^6.3.5",
|
|
42
44
|
"vite-plugin-css-injected-by-js": "^3.5.2",
|
|
43
45
|
"vite-plugin-dts": "^4.5.4"
|
|
44
|
-
}
|
|
46
|
+
},
|
|
47
|
+
"keywords": [
|
|
48
|
+
"react",
|
|
49
|
+
"components",
|
|
50
|
+
"smooth",
|
|
51
|
+
"elegant",
|
|
52
|
+
"modern",
|
|
53
|
+
"web",
|
|
54
|
+
"application",
|
|
55
|
+
"development",
|
|
56
|
+
"poster",
|
|
57
|
+
"cinema"
|
|
58
|
+
]
|
|
45
59
|
}
|