smooth-components 1.1.4 β†’ 1.1.5

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 +76 -1
  2. package/package.json +17 -3
package/README.md CHANGED
@@ -1 +1,76 @@
1
- clean readme
1
+ # πŸ“¦ smooth-components
2
+
3
+ `smooth-components` is a growing collection of elegant, customizable, and accessible React components built to help you quickly craft beautiful web interfaces.
4
+
5
+ [![npm version](https://img.shields.io/npm/v/smooth-components.svg)](https://www.npmjs.com/package/smooth-components)
6
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
7
+
8
+ ---
9
+
10
+ ## πŸš€ Installation
11
+
12
+ Install the package via npm or yarn:
13
+
14
+ ```bash
15
+ npm install smooth-components
16
+ # or
17
+ yarn add smooth-components
18
+ ```
19
+
20
+ ---
21
+
22
+ ## πŸ–ΌοΈ Poster Component
23
+
24
+ The `Poster` component lets you display an image with customizable size, border, opacity, and an optional animated glint overlayβ€”perfect for showcasing posters, artworks, or product previews.
25
+
26
+ ### βœ… Usage
27
+
28
+ ```tsx
29
+ import { Poster } from 'smooth-components'
30
+
31
+ export default function App() {
32
+ return (
33
+ <Poster
34
+ alt="Cyberpunk City"
35
+ src="/images/cyberpunk.jpg"
36
+ styles={{
37
+ width: 240,
38
+ height: 360,
39
+ borderColor: '#555',
40
+ opacity: 0.95,
41
+ }}
42
+ />
43
+ )
44
+ }
45
+ ```
46
+
47
+ ### πŸ”§ Props
48
+
49
+ | Prop | Type | Default | Description |
50
+ | -------------------- | ------------------ | --------- | ------------------------------------------- |
51
+ | `alt` | `string` | β€” | Alternative text for the image. |
52
+ | `src` | `string` | β€” | Image source path or URL. |
53
+ | `styles` | `object` | β€” | Optional inline styles for the container. |
54
+ | `styles.opacity` | `number \| string` | `1` | Opacity of the poster container. |
55
+ | `styles.width` | `number \| string` | `'200px'` | Width of the poster. |
56
+ | `styles.height` | `number \| string` | `'300px'` | Height of the poster. |
57
+ | `styles.borderColor` | `string` | `'#ccc'` | Border color around the poster. |
58
+ | `hasGlintEffect` | `boolean` | `true` | Whether to show the animated glint overlay. |
59
+
60
+ > πŸ’‘ All style values can be in CSS units (`px`, `%`, `em`, etc.) or numbers (interpreted as pixels). The `glint` is a visual shimmer that moves across the image.
61
+
62
+ ---
63
+
64
+ ## πŸ“ License
65
+
66
+ Distributed under the MIT License.
67
+ See [LICENSE](LICENSE) for more information.
68
+
69
+ ---
70
+
71
+ ## πŸ“¬ Contact
72
+
73
+ * 🌐 **Portfolio**: [Visit my website](https://jaime00portfolio.netlify.app/)
74
+ * πŸ’Ό **LinkedIn**: [linkedin.com/in/jaime00](https://www.linkedin.com/in/jaime00)
75
+ * πŸ“§ **Email**: [imjaimetorresv@gmail.com](mailto:imjaimetorresv@gmail.com)
76
+ * πŸ™ **GitHub**: [github.com/jaime00](https://github.com/jaime00)
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.4",
3
+ "description": "A collection of smooth and elegant React components for building modern web applications.",
4
+ "version": "1.1.5",
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
  }