@guidelytech/react-native 0.6.2 → 0.8.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Guidely
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -92,6 +92,39 @@ Provider props: `projectId`, `apiUrl`, `environment`, `storage`, `user`, `debug`
 `showResourceCenterLauncher` (default `false`), `showMessengerLauncher` (default `true`), `insets`,
 `launcherOffset` (default 72).
 
+## Feature flags
+
+Built in, with the same `projectId` — nothing to configure:
+
+```tsx
+import { Feature, FeatureValue, useFeatureValue, useFlag, useGuidely } from "@guidelytech/react-native";
+
+function Checkout() {
+  const newCheckout = useFlag("new-checkout");                       // boolean flags
+  const color = useFeatureValue("checkout-button-color", "blue");    // string / number / JSON
+  return (
+    <Feature flag="new-dashboard-banner" fallback={<OldBanner />}>
+      <NewBanner />
+    </Feature>
+  );
+}
+
+useGuidely().isFeatureEnabled("new-checkout"); // or getFeatureValue / getFeatureDetails / flags
+```
+
+Flags evaluate on the device with `id` (user id, else the anonymous id), `anonymousId`, identify
+traits, `account`, `$audiences`, `screen`, `path`, `platform` (`ios` / `android`), `deviceType`,
+`appVersion`, `locale` and `environment`, plus `flagAttributes` from the provider. The last payload
+is kept in `storage`, so flags work offline from a cold start; they refresh when the app returns to
+the foreground. Experiment exposures are tracked as `experiment_viewed` events.
+
+| | |
+|---|---|
+| `useFlag(key, fallback = false)`, `useFeatureValue(key, fallback)`, `useFlagDetails(key, fallback)`, `useFlags()`, `useFlagsReady()`, `useFlagsClient()` | Hooks (same as `@guidelytech/react`). |
+| `<Feature flag fallback>` (alias `<FeatureFlag>`), `<FeatureValue flag value fallback>` | Conditional rendering. |
+| `<FlagsProvider sdkKey storage attributes>` | Flags only, without guides or analytics. |
+| Provider props `flagAttributes`, `flagsPayload`, `flags` | Extra attributes; a bootstrap payload; `false` or flags client options. |
+
 ## Scout messenger
 
 When Scout is on for iOS/Android (dashboard → Scout → *Show it on*), a chat bubble opens a native