@platform-blocks/ui 0.1.1 → 0.2.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 (25) hide show
  1. package/README.md +27 -33
  2. package/lib/cjs/index.js +1403 -321
  3. package/lib/cjs/index.js.map +1 -1
  4. package/lib/components/FileInput/types.d.ts +12 -3
  5. package/lib/components/Highlight/Highlight.d.ts +4 -0
  6. package/lib/components/Highlight/index.d.ts +3 -0
  7. package/lib/components/Highlight/types.d.ts +24 -0
  8. package/lib/components/MenuItemButton/MenuItemButton.d.ts +29 -1
  9. package/lib/components/Popover/Popover.d.ts +14 -0
  10. package/lib/components/Popover/index.d.ts +2 -0
  11. package/lib/components/Popover/styles.d.ts +66 -0
  12. package/lib/components/Popover/types.d.ts +129 -0
  13. package/lib/components/ShimmerText/ShimmerText.d.ts +1 -0
  14. package/lib/components/Spotlight/Spotlight.d.ts +1 -1
  15. package/lib/components/Spotlight/SpotlightController.d.ts +2 -1
  16. package/lib/components/Spotlight/types.d.ts +3 -1
  17. package/lib/components/Toast/types.d.ts +2 -0
  18. package/lib/components/index.d.ts +4 -0
  19. package/lib/core/factory/factory.d.ts +3 -3
  20. package/lib/core/theme/PlatformBlocksProvider.d.ts +2 -1
  21. package/lib/esm/index.js +1404 -325
  22. package/lib/esm/index.js.map +1 -1
  23. package/lib/index.d.ts +4 -0
  24. package/lib/utils/optionalDependencies.d.ts +13 -0
  25. package/package.json +37 -40
package/README.md CHANGED
@@ -1,44 +1,38 @@
1
- <!-- #host-reference -->
2
- <!-- markdownlint-disable-next-line -->
3
- <p align="center">
4
- <a href="https://platform-blocks.com/core/" rel="noopener" target="_blank"><img width="150" height="133" src="https://mui.com/static/logo.svg" alt="Platform Blocks logo"/></a>
5
- </p>
1
+ # Platform Blocks UI Component Library for React Native
6
2
 
7
- <h1 align="center">Platform Blocks</h1>
3
+ ## Compatibility
8
4
 
9
- <div align="center">
5
+ - `react` `>=18.0.0 <20.0.0`
6
+ - `react-native` `>=0.73.0`
7
+ - `react-native-reanimated` `>=3.4.0`
8
+ - `react-native-safe-area-context` `>=4.5.0`
9
+ - `react-native-svg` `>=13.0.0`
10
+ - Optional integrations: `expo-audio`, `expo-document-picker`, `expo-haptics`, `expo-linear-gradient`, `expo-status-bar`, `react-syntax-highlighter`, `@react-native-masked-view/masked-view`, `@shopify/flash-list`, `react-native-reanimated-carousel`
10
11
 
11
- [![NPM](https://img.shields.io/npm/l/@mantine/core)](https://github.com/joshstovall/platform-blocks/blob/master/LICENSE)
12
- [![npm](https://img.shields.io/npm/v/platform-blocks)](https://www.npmjs.com/package/@mantine/core)
13
- [![Discord](https://img.shields.io/badge/Chat%20on-Discord-%235865f2)](https://discord.gg/wbH82zuWMN)
12
+ The library lazily requires optional modules, so they only need to be installed when you use features that depend on them.
14
13
 
15
- </div>
14
+ ## Installation
16
15
 
17
- [Platform Blocks](https://platform-blocks.com/material-ui/) is a comprehensive React Native UI library for building beautiful, accessible, and highly customizable mobile and web applications.
16
+ Install peer dependencies that match your application runtime, then add the package:
18
17
 
19
- ## Documentation
18
+ ```bash
19
+ npm install @platform-blocks/ui
20
+ ```
20
21
 
21
- Get started in the [Platform Blocks documentation](https://platform-blocks.com/).
22
+ If you rely on optional integrations, add them with versions compatible with your project’s React Native or Expo SDK.
22
23
 
24
+ ## Usage
23
25
 
24
- ## Packages
26
+ ```tsx
27
+ import { PlatformBlocksProvider, Button } from '@platform-blocks/ui';
25
28
 
26
- - [`@platform-blocks/ui`](#) – core components library – 100+ components
27
- - [`@platform-blocks/ui`](#) – 100+ icons for use in your applications
29
+ export function App() {
30
+ return (
31
+ <PlatformBlocksProvider>
32
+ <Button label="Hello" />
33
+ </PlatformBlocksProvider>
34
+ );
35
+ }
36
+ ```
28
37
 
29
- ## Examples
30
-
31
- Our documentation includes [example projects](#).
32
-
33
- ## Contributors
34
-
35
- <a href="https://github.com/mantinedev/mantine/graphs/contributors">
36
- <img src="https://contrib.rocks/image?repo=joshstovall/platform-blocks" />
37
- </a>
38
-
39
- [Become a contributor](https://platform-blocks.com/contribute)
40
-
41
- ## License
42
- [![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/joshstovall/platform-blocks/blob/HEAD/LICENSE)
43
-
44
- [MIT license](/LICENSE)
38
+ Refer to the documentation site for component examples and API details.