react-native-vorn-button

A small customizable React Native button component with optional icons and a press overlay animation.

Installation

Using npm (library published as react-native-vorn-button):

npm install react-native-vorn-button
# or
yarn add react-native-vorn-button

Icon dependency:

• Bare RN / non-Expo: react-native-vector-icons

npm install react-native-vector-icons
# iOS
npx pod-install

• Expo managed:

expo install @expo/vector-icons

Usage

Basic example:

import VornButton from 'react-native-vorn-button';

// if you use react-native-vector-icons
import FontAwesome from 'react-native-vector-icons/FontAwesome';

// or in Expo
// import { FontAwesome } from '@expo/vector-icons';

<NativeButton trailingIcon="arrow-right" onPress={() => {}}>
Press Me
</NativeButton>

Props

• onPress: () => void — press handler
• backgroundColor?: string — button background (default #6367FF)
• foregroundColor?: string — text/icon color (default #FFFFFF)
• leadingIcon?: string — FontAwesome icon name
• leadingIconColor?: string
• leadingIconSize?: number
• trailingIcon?: string
• trailingIconColor?: string
• trailingIconSize?: number
• children: string — react node

(Props are optional where noted; see types in src/types/NativeButton.types.)

Notes

• The component uses react-native-reanimated for touch overlay/animations. Ensure it is installed in your project.
• The overlay is rendered inside the button and uses pointerEvents="none" so it does not block touches.

Building & Publishing (maintainer)

• Local build (bob):

yarn install
yarn prepare   # runs `bob build` per package.json

• Publish:
  • Interactive 2FA:

    npm publish --access public --otp 123456

  • CI / non-interactive: create an npm Automation token (bypass 2FA), set NPM_TOKEN and write .npmrc before publish:

    export NPM_TOKEN="<<TOKEN>>"
    printf "//registry.npmjs.org/:_authToken=${NPM_TOKEN}\n" > .npmrc
    npm publish --access public
    rm .npmrc
    unset NPM_TOKEN

Contributing

See CONTRIBUTING.md for development workflow and examples.

License

MIT