@togglely/sdk-react 1.0.0

package/README.md

@@ -0,0 +1,113 @@
+# @togglely/sdk-react
+
+React SDK for Togglely - Feature toggles with hooks.
+
+## Installation
+
+```bash
+npm install @togglely/sdk-react
+```
+
+## Usage
+
+### Provider
+
+Wrap your app with `TogglelyProvider`:
+
+```tsx
+import { TogglelyProvider } from '@togglely/sdk-react';
+
+function App() {
+  return (
+    <TogglelyProvider 
+      apiKey="your-api-key"
+      environment="production"
+      baseUrl="https://your-togglely-instance.com"
+    >
+      <MyApp />
+    </TogglelyProvider>
+  );
+}
+```
+
+### Hooks
+
+#### `useToggle(key, defaultValue)`
+
+Check if a boolean feature toggle is enabled:
+
+```tsx
+function MyComponent() {
+  const isEnabled = useToggle('new-feature', false);
+  return isEnabled ? <NewFeature /> : <OldFeature />;
+}
+```
+
+#### `useStringToggle(key, defaultValue)`
+
+Get a string toggle value:
+
+```tsx
+const message = useStringToggle('welcome-message', 'Hello');
+```
+
+#### `useNumberToggle(key, defaultValue)`
+
+Get a number toggle value:
+
+```tsx
+const limit = useNumberToggle('max-items', 10);
+```
+
+#### `useJSONToggle(key, defaultValue)`
+
+Get a JSON toggle value:
+
+```tsx
+const config = useJSONToggle('app-config', { theme: 'light' });
+```
+
+#### `useToggles()`
+
+Get all toggles:
+
+```tsx
+const toggles = useToggles();
+// toggles = { 'new-feature': { value: true, enabled: true }, ... }
+```
+
+#### `useTogglelyState()`
+
+Get the SDK state:
+
+```tsx
+const state = useTogglelyState();
+// state = { isReady: true, isOffline: false, lastError: null, lastFetch: Date }
+```
+
+### Components
+
+#### `FeatureToggle`
+
+Conditionally render content:
+
+```tsx
+import { FeatureToggle } from '@togglely/sdk-react';
+
+<FeatureToggle toggle="new-feature" fallback={<OldFeature />}>
+  <NewFeature />
+</FeatureToggle>
+```
+
+### SSR Support
+
+Pass initial toggles for server-side rendering:
+
+```tsx
+<TogglelyProvider 
+  apiKey="your-api-key"
+  environment="production"
+  baseUrl="https://your-togglely-instance.com"
+  initialToggles={{ 'new-feature': true }}
+>
+```

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@togglely/sdk-react",
+  "version": "1.0.0",
+  "description": "React SDK for Togglely - Feature toggles with hooks",
+  "main": "dist/index.js",
+  "module": "dist/index.esm.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc && rollup -c",
+    "test": "jest"
+  },
+  "keywords": [
+    "feature-flags",
+    "feature-toggles",
+    "togglely",
+    "react",
+    "hooks"
+  ],
+  "author": "Togglely",
+  "license": "MIT",
+  "peerDependencies": {
+    "react": "^16.8.0 || ^17.0.0 || ^18.0.0",
+    "react-dom": "^16.8.0 || ^17.0.0 || ^18.0.0"
+  },
+  "dependencies": {
+    "@togglely/sdk-core": "^1.0.0"
+  },
+  "devDependencies": {
+    "@rollup/plugin-typescript": "^11.1.5",
+    "@types/react": "^18.2.45",
+    "rollup": "^4.9.1",
+    "tslib": "^2.6.2",
+    "typescript": "^5.3.3"
+  }
+}