@space-uy/pulsar-ui 0.2.0 → 0.5.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 +54 -56
  2. package/package.json +3 -3
package/README.md CHANGED
@@ -1,13 +1,11 @@
1
- # @space-uy/pulsar-ui
1
+ <div align="right">
2
2
 
3
- <div align="center">
3
+ <img src="./assets/banner.png">
4
4
 
5
5
  ![Version](https://img.shields.io/badge/version-0.1.0-blue.svg?cacheSeconds=2592000)
6
6
  ![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)
7
7
  [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](CONTRIBUTING.md)
8
8
 
9
- A modern React Native UI kit for SpaceDev applications, providing a collection of reusable components and utilities.
10
-
11
9
  </div>
12
10
 
13
11
  ## ✨ Features
@@ -29,74 +27,74 @@ npm install @space-uy/pulsar-ui
29
27
 
30
28
  # Using yarn
31
29
  yarn add @space-uy/pulsar-ui
32
-
33
- # Using pnpm
34
- pnpm add @space-uy/pulsar-ui
35
- ```
36
-
37
- ### Peer Dependencies
38
-
39
- This library requires the following peer dependencies to be installed in your project:
40
-
41
- ```json
42
- {
43
- "@react-navigation/elements": "^2.3.8", // Required for navigation components
44
- "lucide-react-native": "^0.503.0", // Required for icons
45
- "react": "*", // Core React dependency
46
- "react-native": "*", // Core React Native dependency
47
- "react-native-gesture-handler": "^2.25.0", // Required for gesture interactions
48
- "react-native-reanimated": "~3.16.1", // Required for animations
49
- "react-native-svg": "^15.11.2" // Required for SVG support
50
- }
51
30
  ```
52
31
 
53
- #### Installation
54
-
55
- You can install all peer dependencies at once using:
32
+ ### Install peer dependencies:
56
33
 
57
34
  ```sh
58
35
  # Using npm
59
- npm install @react-navigation/elements@^2.3.8 lucide-react-native@^0.503.0 react-native-gesture-handler@^2.25.0 react-native-reanimated@~3.16.1 react-native-svg@^15.11.2
36
+ npm install react-native-svg react-native-gesture-handler react-native-reanimated lucide-react-native zustand @react-navigation/elements
60
37
 
61
38
  # Using yarn
62
- yarn add @react-navigation/elements@^2.3.8 lucide-react-native@^0.503.0 react-native-gesture-handler@^2.25.0 react-native-reanimated@~3.16.1 react-native-svg@^15.11.2
63
-
64
- # Using pnpm
65
- pnpm add @react-navigation/elements@^2.3.8 lucide-react-native@^0.503.0 react-native-gesture-handler@^2.25.0 react-native-reanimated@~3.16.1 react-native-svg@^15.11.2
39
+ yarn add react-native-svg react-native-gesture-handler react-native-reanimated lucide-react-native zustand @react-navigation/elements
66
40
  ```
67
41
 
68
- Note: `react` and `react-native` are typically already installed in your React Native project, so you don't need to install them separately.
69
-
70
42
  ## 🚀 Quick Start
71
43
 
72
- ```jsx
73
- import { Button } from '@space-uy/pulsar-ui';
44
+ ```tsx
45
+ import React from 'react';
46
+ import { View, StyleSheet } from 'react-native';
47
+ import { Button, Text, Card } from '@space-uy/pulsar-ui';
48
+
49
+ export default function App() {
50
+ const handlePress = () => {
51
+ console.log('Button pressed!');
52
+ };
74
53
 
75
- function MyApp() {
76
54
  return (
77
- <>
78
- {/* Primary button */}
79
- <Button text="Click me" onPress={() => console.log('Button pressed!')} />
80
-
81
- {/* Outline button */}
82
- <Button
83
- text="Outline Button"
84
- variant="outlined"
85
- onPress={() => console.log('Outline button pressed!')}
86
- />
87
-
88
- {/* Small button with icon */}
89
- <Button
90
- text="Small Button"
91
- size="small"
92
- iconName="Plus"
93
- onPress={() => console.log('Small button pressed!')}
94
- />
95
- </>
55
+ <View style={styles.container}>
56
+ <Card style={styles.card}>
57
+ <Text variant="h2" style={styles.title}>
58
+ Welcome to Pulsar UI
59
+ </Text>
60
+ <Text variant="pm" style={styles.description}>
61
+ This is a basic example of how to use our components.
62
+ </Text>
63
+ <Button
64
+ text="Get Started"
65
+ onPress={handlePress}
66
+ iconName="ArrowRight"
67
+ />
68
+ </Card>
69
+ </View>
96
70
  );
97
71
  }
72
+
73
+ const styles = StyleSheet.create({
74
+ container: {
75
+ flex: 1,
76
+ padding: 20,
77
+ justifyContent: 'center',
78
+ },
79
+ card: {
80
+ padding: 20,
81
+ },
82
+ title: {
83
+ marginBottom: 12,
84
+ },
85
+ description: {
86
+ marginBottom: 20,
87
+ opacity: 0.7,
88
+ },
89
+ });
98
90
  ```
99
91
 
92
+ ## 📚 Documentation
93
+
94
+ For detailed documentation, examples, and interactive playground, visit:
95
+
96
+ **🌐 [Pulsar UI Documentation & Playground](https://spaceuy.github.io/pulsar-ui/)**
97
+
100
98
  ## 🛠️ Development
101
99
 
102
100
  ### Prerequisites
@@ -111,7 +109,7 @@ function MyApp() {
111
109
 
112
110
  ```sh
113
111
  git clone https://github.com/SpaceUY/pulsar-ui.git
114
- cd @space-uy/pulsar-ui
112
+ cd pulsar-ui
115
113
  ```
116
114
 
117
115
  2. Install dependencies:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@space-uy/pulsar-ui",
3
- "version": "0.2.0",
3
+ "version": "0.5.0",
4
4
  "description": "react native ui kit for spacedev",
5
5
  "source": "./src/index.tsx",
6
6
  "main": "./lib/module/index.js",
@@ -77,7 +77,7 @@
77
77
  "eslint-config-prettier": "^10.1.1",
78
78
  "eslint-plugin-prettier": "^5.2.3",
79
79
  "jest": "^29.7.0",
80
- "lucide-react-native": "^0.503.0",
80
+ "lucide-react-native": ">=0.508.0",
81
81
  "prettier": "^3.0.3",
82
82
  "react": "18.3.1",
83
83
  "react-native": "0.76.9",
@@ -93,7 +93,7 @@
93
93
  },
94
94
  "peerDependencies": {
95
95
  "@react-navigation/elements": "^2.3.8",
96
- "lucide-react-native": "^0.503.0",
96
+ "lucide-react-native": ">=0.508.0",
97
97
  "react": "*",
98
98
  "react-native": "*",
99
99
  "react-native-gesture-handler": "^2.25.0",