react-native-tinykit

Features

Requirements

Installation

# Using npm
npm install react-native-tinykit
# Using yarn
yarn add react-native-tinykit

iOS Setup

cd ios && pod install

Usage

Restart Application

import { restart } from 'react-native-tinykit';
// Restart the app
restart();

Example Use Cases

Thermal State

import { getThermalState, onThermalStateChange } from 'react-native-tinykit';
// Get current thermal state
const state = getThermalState();
console.log('Current thermal state:', state);
// Listen for thermal state changes
const subscription = onThermalStateChange((state) => {
 console.log('Thermal state changed:', state);
 switch (state) {
 case 'nominal':
 // Normal operating conditions
 break;
 case 'fair':
 // Slightly elevated thermal state
 break;
 case 'serious':
 // High thermal state - consider reducing activity
 break;
 case 'critical':
 // Critical thermal state - reduce activity immediately
 break;
 }
});
// Clean up the listener when done
subscription.remove();

Example Use Cases

Keep Awake

import {
 activate,
 deactivate,
 useKeepAwake,
 KeepAwake,
} from 'react-native-tinykit';
// Imperative API
activate(); // Keep screen awake
deactivate(); // Allow screen to auto-lock
// Hook - keeps screen awake while the component is mounted
function VideoPlayer() {
 useKeepAwake();
 return <Video />;
}
// Component - keeps screen awake while mounted
function App() {
 return (
 <>
 <KeepAwake />
 <MyContent />
 </>
 );
}

Example Use Cases

Haptic Feedback

import { impact, selection, notification } from 'react-native-tinykit';
// Impact feedback - physical "tap" sensation
impact('light');
impact('medium');
impact('heavy');
impact('soft');
impact('rigid');
// Selection feedback - subtle "tick" for selection changes
selection();
// Notification feedback - communicates success, warning, or error
notification('success');
notification('warning');
notification('error');

Example Use Cases

App Review

import { requestReview } from 'react-native-tinykit';
// Request review
await requestReview();

Example Use Cases

Color Picker

import { showColorPicker } from 'react-native-tinykit';
const result = await showColorPicker({
 selectedColor: '#007AFF',
 supportsAlpha: true,
 supportsEyedropper: true,
 maximumLinearExposure: 1,
 title: 'Pick a Color',
 showDoneButton: true,
 detents: [
 { type: 'custom', identifier: 'compact', height: 420 },
 { type: 'large' },
 ],
 selectedDetentIdentifier: 'compact',
 prefersGrabberVisible: true,
});
console.log(result.color); // #RRGGBBAA

API Reference

restart()

restart(): void

import { restart } from 'react-native-tinykit';
const handleLogout = async () => {
 await clearUserData();
 restart(); // Restart app to reset state
};

getThermalState()

getThermalState(): ThermalState

import { getThermalState } from 'react-native-tinykit';
const state = getThermalState();
if (state === 'critical') {
 // Reduce app activity to help cool down the device
}

onThermalStateChange()

onThermalStateChange(listener: (state: ThermalState) => void): { remove: () => void }

import { onThermalStateChange } from 'react-native-tinykit';
const subscription = onThermalStateChange((state) => {
 console.log('Thermal state changed to:', state);
});
// Later, when you want to stop listening:
subscription.remove();

activate()

activate(): void

import { activate } from 'react-native-tinykit';
activate();

deactivate()

deactivate(): void

import { deactivate } from 'react-native-tinykit';
deactivate();

useKeepAwake()

useKeepAwake(): void

import { useKeepAwake } from 'react-native-tinykit';
function VideoPlayer() {
 useKeepAwake();
 return <Video />;
}

<KeepAwake />

<KeepAwake />

import { KeepAwake } from 'react-native-tinykit';
function App() {
 const [isPlaying, setIsPlaying] = useState(false);
 return (
 <>
 {isPlaying && <KeepAwake />}
 <VideoPlayer onPlay={() => setIsPlaying(true)} />
 </>
 );
}

impact()

impact(style: ImpactFeedbackStyle): void

import { impact } from 'react-native-tinykit';
const handlePress = () => {
 impact('medium');
};

selection()

selection(): void

import { selection } from 'react-native-tinykit';
const handleSelectionChange = () => {
 selection();
};

notification()

notification(type: NotificationFeedbackType): void

import { notification } from 'react-native-tinykit';
const handleSubmit = async () => {
 try {
 await submitForm();
 notification('success');
 } catch {
 notification('error');
 }
};

requestReview()

requestReview(): Promise<void>

import { requestReview } from 'react-native-tinykit';
const handleReview = async () => {
 try {
 await requestReview();
 } catch (error) {
 console.error('Failed to request review:', error);
 }
};

showColorPicker()

showColorPicker(options?: ColorPickerOptions): Promise<ColorPickerResult>

type ColorPickerDetent = {
 type: 'medium' | 'large' | 'custom';
 identifier?: string;
 height?: number; // custom height in points
 fraction?: number; // custom fraction of maximum sheet height
};

type ColorPickerResult = {
 color: string; // #RRGGBBAA
 red: number;
 green: number;
 blue: number;
 alpha: number;
};

Apps Using This Library

Contributing

License