@codewithbeto/ui

A React Native UI component library built for Expo applications.

Overview

This package provides reusable UI components for React Native applications. Components are built on top of React Native primitives and are designed to work seamlessly with Expo.

Installation

pnpm add @codewithbeto/ui

Or with npm:

npm install @codewithbeto/ui

Quick Start

import { Text } from "@codewithbeto/ui";

export default function App() {
  return <Text type="title">Hello World</Text>;
}

Components

• Text - Lightweight text component with multiple size variants and full React Native Text compatibility

Development

Local Development Setup

This package is part of a pnpm workspace. For local development:

1. Clone the repository and install dependencies:

   pnpm install

2. Use the workspace link in apps/example to test your changes:

   import { Text } from "@codewithbeto/ui";

3. Changes will hot-reload automatically in Expo.

Building

Before publishing, you must build the package to compile TypeScript to JavaScript:

pnpm --filter @codewithbeto/ui build

This command:

• Compiles TypeScript files from src/ to JavaScript in dist/
• Generates TypeScript declaration files (.d.ts) for type support
• Creates source maps for debugging

Why build? We publish compiled JavaScript to npm, not TypeScript source files. This ensures:

• Faster installs (no compilation needed)
• Smaller package size
• Better compatibility across different TypeScript versions

Type Checking

Run type checking without building:

pnpm --filter @codewithbeto/ui typecheck

Publishing

Publishing is automated via GitHub Actions. No local .npmrc or Personal Access Token is required.

How It Works

The repository includes a publish workflow that:

• Triggers automatically when a GitHub Release is created
• Publishes as latest for stable releases, or beta for pre-releases
• Builds the package and publishes it to npm
• Uses an NPM_TOKEN repository secret for authentication

Versioning

This package follows the Expo SDK versioning scheme. The major version matches the Expo SDK version it's built and tested against. For example, @codewithbeto/[email protected] is designed for Expo SDK 55. This makes it easy to identify at a glance that your packages are compatible with your SDK version.

Within a major version, we use patch bumps for bug fixes and minor bumps for new features:

• Patch (55.0.0 → 55.0.1): Bug fixes, small improvements
• Minor (55.0.0 → 55.1.0): New features (backward compatible)

Publishing a Stable Release

1. Bump the version in package.json.

2. Commit the version bump and push to main.

3. Create a GitHub Release:

   • Go to the Releases page
   • Click "Draft a new release"
   • Create a new tag matching the version (e.g., v55.0.0)
   • Add release notes describing the changes
   • Click "Publish release"

4. The workflow will automatically build and publish the package under the latest tag.

Publishing a Beta Release

Beta releases let you test new changes without affecting users on the stable version.

1. Bump the version with a prerelease identifier, e.g. 55.0.0-beta.1.

2. Commit the version bump and push to your branch.

3. Create a GitHub Release:

   • Go to the Releases page
   • Create a new tag matching the version (e.g., v55.0.0-beta.1)
   • Check the "Set as a pre-release" checkbox
   • Click "Publish release"

4. The workflow detects the pre-release flag and publishes under the beta dist-tag instead of latest.

Installing a beta version:

pnpm add @codewithbeto/ui@beta

Users who run pnpm add @codewithbeto/ui (without @beta) will continue to get the latest stable version.

Promoting Beta to Stable

Once a beta has been tested and is ready for production:

1. Update the version in package.json to the stable version (remove the prerelease identifier):

   • 55.0.0-beta.3 → 55.0.0

2. Commit the version bump and push to main.

3. Create a regular GitHub Release (do not check "Set as a pre-release"):

   • Create a new tag matching the stable version (e.g., v55.0.0)
   • Click "Publish release"

4. The workflow publishes the package under latest. All users will get the stable version on their next install or update.

Example: Full Release Lifecycle

Here's a typical workflow from development to stable release:

| Step | Version in package.json | Git Tag | Pre-release? | Dist-tag | |------|---------------------------|---------|--------------|----------| | First beta | 55.0.0-beta.1 | v55.0.0-beta.1 | Yes | beta | | Fix a bug in beta | 55.0.0-beta.2 | v55.0.0-beta.2 | Yes | beta | | Promote to stable | 55.0.0 | v55.0.0 | No | latest |

You can also trigger the workflow manually from the Actions tab with a custom dist-tag if needed.

Package Configuration

The package is configured to publish to npm:

• Registry: https://registry.npmjs.org
• Scope: @codewithbeto
• Access: Public
• Files included: Only the dist/ folder (specified in package.json)

Adding New Components

Follow this structure when adding new components:

1. Create a new folder in src/components/:

   src/components/MyComponent/
   ├── MyComponent.tsx    # Component implementation
   ├── README.md          # Component documentation
   └── index.ts           # Exports

2. Create the component with TypeScript:

   // src/components/MyComponent/MyComponent.tsx
   import { View } from "react-native";
   
   export interface MyComponentProps {
     // your props
   }
   
   export function MyComponent({ ...props }: MyComponentProps) {
     return <View>...</View>;
   }

3. Create the component index file:

   // src/components/MyComponent/index.ts
   export { MyComponent, type MyComponentProps } from "./MyComponent";

4. Export from the main src/index.ts:

   export { MyComponent, type MyComponentProps } from "./components/MyComponent";

5. Add comprehensive documentation to the component's README.md including:

   • Component description and features
   • Props table with types and descriptions
   • Usage examples
   • TypeScript examples

6. Update the Components section above with a link to your new component's README.

7. Test in apps/example before publishing.

License

This package is licensed under the MIT License.