<!-- LLM Context: This is the official AppGram react-native SDK documentation. -->
<!-- Use this documentation to help users integrate AppGram into their react-native applications. -->
<!-- AppGram provides: feature requests, roadmaps, changelogs, help centers, support tickets, and status pages. -->

# @appgram/react-native

> **Platform:** react-native | **Language:** TypeScript
>
> Generated: 2026-02-24T21:05:28.247Z

> **Note for AI assistants:** This SDK allows developers to integrate AppGram's product feedback and communication features. Key components include providers, hooks, and pre-built UI components.

---

## Table of Contents

- [AppgramProvider](#appgramprovider)
- [AppgramClient](#appgramclient)
- [useAppgramContext](#useappgramcontext)
- [useAppgramTheme](#useappgramtheme)
- [useBlogCategories](#useblogcategories)
- [useBlogPost](#useblogpost)
- [useBlogPosts](#useblogposts)
- [useComments](#usecomments)
- [useFeaturedPosts](#usefeaturedposts)
- [useForm](#useform)
- [useFormSubmit](#useformsubmit)
- [useHelpArticle](#usehelparticle)
- [useHelpCenter](#usehelpcenter)
- [useHelpFlow](#usehelpflow)
- [useRelease](#userelease)
- [useReleases](#usereleases)
- [useRoadmap](#useroadmap)
- [useStatus](#usestatus)
- [useSupport](#usesupport)
- [useSurvey](#usesurvey)
- [useSurveySubmit](#usesurveysubmit)
- [useVote](#usevote)
- [useWishes](#usewishes)
- [Badge](#badge)
- [Blog](#blog)
- [BlogCard](#blogcard)
- [BlogList](#bloglist)
- [BlogPostDetail](#blogpostdetail)
- [Button](#button)
- [Card](#card)
- [ChatScreen](#chatscreen)
- [FormRenderer](#formrenderer)
- [HelpArticleCard](#helparticlecard)
- [HelpArticleDetail](#helparticledetail)
- [HelpCenter](#helpcenter)
- [HelpFlowCard](#helpflowcard)
- [HelpFlowDetail](#helpflowdetail)
- [Input](#input)
- [ReleaseDetail](#releasedetail)
- [ReleaseList](#releaselist)
- [Releases](#releases)
- [RoadmapBoard](#roadmapboard)
- [StatusBoard](#statusboard)
- [SubmitWishSheet](#submitwishsheet)
- [SupportForm](#supportform)
- [SurveyForm](#surveyform)
- [VoteButton](#votebutton)
- [WishCard](#wishcard)
- [WishDetailModal](#wishdetailmodal)
- [WishList](#wishlist)
- [SubmitWishSheetProps](#submitwishsheetprops)
- [UseVoteOptions](#usevoteoptions)
- [UseVoteResult](#usevoteresult)
- [UseWishesOptions](#usewishesoptions)
- [UseWishesResult](#usewishesresult)
- [Vote](#vote)
- [VoteButtonProps](#votebuttonprops)
- [VoteCheckResponse](#votecheckresponse)
- [Wish](#wish)
- [WishAuthor](#wishauthor)
- [WishCardProps](#wishcardprops)
- [WishDetailModalProps](#wishdetailmodalprops)
- [WishesResponse](#wishesresponse)
- [WishFilters](#wishfilters)
- [WishListProps](#wishlistprops)
- [HelpArticle](#helparticle)
- [HelpArticleCardProps](#helparticlecardprops)
- [HelpArticleDetailProps](#helparticledetailprops)
- [HelpCenterProps](#helpcenterprops)
- [HelpCollection](#helpcollection)
- [HelpFlow](#helpflow)
- [HelpFlowCardProps](#helpflowcardprops)
- [HelpFlowDetailProps](#helpflowdetailprops)
- [UseHelpArticleResult](#usehelparticleresult)
- [UseHelpCenterResult](#usehelpcenterresult)
- [UseHelpFlowResult](#usehelpflowresult)
- [Release](#release)
- [ReleaseDetailProps](#releasedetailprops)
- [ReleaseFeature](#releasefeature)
- [ReleaseListProps](#releaselistprops)
- [ReleasesProps](#releasesprops)
- [UseReleaseOptions](#usereleaseoptions)
- [UseReleaseResult](#usereleaseresult)
- [UseReleasesOptions](#usereleasesoptions)
- [UseReleasesResult](#usereleasesresult)
- [RoadmapBoardProps](#roadmapboardprops)
- [RoadmapColumn](#roadmapcolumn)
- [RoadmapData](#roadmapdata)
- [RoadmapItem](#roadmapitem)
- [UseRoadmapOptions](#useroadmapoptions)
- [UseRoadmapResult](#useroadmapresult)
- [StatusBoardProps](#statusboardprops)
- [StatusPage](#statuspage)
- [StatusPageOverview](#statuspageoverview)
- [StatusPageService](#statuspageservice)
- [UseStatusOptions](#usestatusoptions)
- [UseStatusResult](#usestatusresult)
- [StoredTicket](#storedticket)
- [SupportAttachment](#supportattachment)
- [SupportFormProps](#supportformprops)
- [SupportMessage](#supportmessage)
- [SupportRequest](#supportrequest)
- [SupportRequestInput](#supportrequestinput)
- [SupportSubmitData](#supportsubmitdata)
- [UseSupportOptions](#usesupportoptions)
- [UseSupportResult](#usesupportresult)
- [Survey](#survey)
- [SurveyAnswer](#surveyanswer)
- [SurveyFormProps](#surveyformprops)
- [SurveyNode](#surveynode)
- [SurveyNodeOption](#surveynodeoption)
- [SurveyResponse](#surveyresponse)
- [SurveySubmitInput](#surveysubmitinput)
- [UseSurveyOptions](#usesurveyoptions)
- [UseSurveyResult](#usesurveyresult)
- [UseSurveySubmitOptions](#usesurveysubmitoptions)
- [UseSurveySubmitResult](#usesurveysubmitresult)
- [BlogCardProps](#blogcardprops)
- [BlogCategory](#blogcategory)
- [BlogFilters](#blogfilters)
- [BlogListProps](#bloglistprops)
- [BlogPost](#blogpost)
- [BlogPostDetailProps](#blogpostdetailprops)
- [BlogPostsResponse](#blogpostsresponse)
- [BlogProps](#blogprops)
- [UseBlogCategoriesOptions](#useblogcategoriesoptions)
- [UseBlogCategoriesResult](#useblogcategoriesresult)
- [UseBlogPostOptions](#useblogpostoptions)
- [UseBlogPostResult](#useblogpostresult)
- [UseBlogPostsOptions](#useblogpostsoptions)
- [UseBlogPostsResult](#useblogpostsresult)
- [ApiResponse](#apiresponse)
- [AppgramClientConfig](#appgramclientconfig)
- [AppgramColors](#appgramcolors)
- [AppgramConfig](#appgramconfig)
- [AppgramProviderProps](#appgramproviderprops)
- [AppgramTheme](#appgramtheme)
- [BadgeProps](#badgeprops)
- [ButtonProps](#buttonprops)
- [CardProps](#cardprops)
- [Category](#category)
- [ChatScreenProps](#chatscreenprops)
- [ChatSource](#chatsource)
- [Comment](#comment)
- [CommentAuthor](#commentauthor)
- [CommentCreateInput](#commentcreateinput)
- [CommentsResponse](#commentsresponse)
- [Form](#form)
- [FormField](#formfield)
- [FormRendererProps](#formrendererprops)
- [FormSubmission](#formsubmission)
- [InputProps](#inputprops)
- [PaginatedResponse](#paginatedresponse)
- [UseCommentsOptions](#usecommentsoptions)
- [UseCommentsResult](#usecommentsresult)
- [UseFeaturedPostsOptions](#usefeaturedpostsoptions)
- [UseFeaturedPostsResult](#usefeaturedpostsresult)
- [UseFormOptions](#useformoptions)
- [UseFormResult](#useformresult)
- [UseFormSubmitOptions](#useformsubmitoptions)
- [UseFormSubmitResult](#useformsubmitresult)
- [ArticleType](#articletype)
- [FlowDisplayType](#flowdisplaytype)
- [FormFieldType](#formfieldtype)
- [StatusState](#statusstate)
- [StatusType](#statustype)
- [SupportRequestCategory](#supportrequestcategory)
- [SupportRequestPriority](#supportrequestpriority)
- [SupportRequestStatus](#supportrequeststatus)
- [SurveyQuestionType](#surveyquestiontype)
- [ThemeMode](#thememode)
- [WishStatus](#wishstatus)
- [getErrorMessage](#geterrormessage)
- [getFingerprint](#getfingerprint)

---

## AppgramProvider

**Kind:** `component` | **Access:** `public`

### Declaration

```typescript
function AppgramProvider(props: AppgramProviderProps): ReactElement
```

### Description

Root provider component for the Appgram SDK.
Provides configuration, API client, theming, and fingerprinting to all child components.

---

## AppgramClient

**Kind:** `class` | **Access:** `public`

### Declaration

```typescript
class AppgramClient
```

### Initializers

#### `constructor`

```typescript
constructor(config: AppgramClientConfig)
```

### Methods

#### `addSupportMessage` `async`

```typescript
async addSupportMessage(ticketId: string, token: string, content: string): Promise<ApiResponse<object>>
```

Add a message to a support ticket

#### `checkVote` `async`

```typescript
async checkVote(wishId: string, fingerprint: string): Promise<ApiResponse<VoteCheckResponse>>
```

Check if a fingerprint has voted on a wish

#### `createComment` `async`

```typescript
async createComment(data: object): Promise<ApiResponse<Comment>>
```

Create a comment

#### `createVote` `async`

```typescript
async createVote(wishId: string, fingerprint: string, voterEmail?: string): Promise<ApiResponse<object>>
```

Create a vote

#### `createWish` `async`

```typescript
async createWish(data: object): Promise<ApiResponse<Wish>>
```

Create a new wish (feature request)

#### `deleteVote` `async`

```typescript
async deleteVote(voteId: string): Promise<ApiResponse<object>>
```

Delete a vote

#### `getBlogCategories` `async`

```typescript
async getBlogCategories(): Promise<ApiResponse<BlogCategory[]>>
```

Get blog categories

#### `getBlogPost` `async`

```typescript
async getBlogPost(slug: string): Promise<ApiResponse<BlogPost>>
```

Get a single blog post by slug

#### `getBlogPosts` `async`

```typescript
async getBlogPosts(filters?: BlogFilters): Promise<ApiResponse<BlogPostsResponse>>
```

Get public blog posts with optional filters

#### `getBlogPostsByCategory` `async`

```typescript
async getBlogPostsByCategory(categorySlug: string, options?: object): Promise<ApiResponse<BlogPostsResponse>>
```

Get blog posts by category slug

#### `getBlogPostsByTag` `async`

```typescript
async getBlogPostsByTag(tag: string, options?: object): Promise<ApiResponse<BlogPostsResponse>>
```

Get blog posts by tag

#### `getComments` `async`

```typescript
async getComments(wishId: string, options?: object): Promise<ApiResponse<CommentsResponse>>
```

Get comments for a wish

#### `getFeaturedBlogPosts` `async`

```typescript
async getFeaturedBlogPosts(): Promise<ApiResponse<BlogPost[]>>
```

Get featured blog posts

#### `getForm` `async`

```typescript
async getForm(formId: string): Promise<ApiResponse<Form>>
```

Get a form by ID via portal endpoint

#### `getHelpArticle` `async`

```typescript
async getHelpArticle(slug: string, flowId: string): Promise<ApiResponse<HelpArticle>>
```

Get a help article by slug

#### `getHelpCollection` `async`

```typescript
async getHelpCollection(): Promise<ApiResponse<object>>
```

Get help center collection for the project

#### `getHelpFlow` `async`

```typescript
async getHelpFlow(slug: string): Promise<ApiResponse<HelpFlow>>
```

Get a help flow by slug

#### `getPageData` `async`

```typescript
async getPageData(): Promise<ApiResponse<object>>
```

Get all public page data in one request

#### `getPublicStatusOverview` `async`

```typescript
async getPublicStatusOverview(slug: string): Promise<ApiResponse<StatusPageOverview>>
```

Get public status page overview (services, active updates, overall status)

#### `getPublicSurvey` `async`

```typescript
async getPublicSurvey(slug: string): Promise<ApiResponse<Survey & object>>
```

Get a public survey by slug

#### `getPublicSurveyCustomization` `async`

```typescript
async getPublicSurveyCustomization(surveyId: string): Promise<ApiResponse<Record<string, unknown>>>
```

Get survey customization settings

#### `getPublicWishes` `async`

```typescript
async getPublicWishes(filters?: WishFilters): Promise<ApiResponse<WishesResponse>>
```

Get public wishes for the project

#### `getRelatedBlogPosts` `async`

```typescript
async getRelatedBlogPosts(slug: string): Promise<ApiResponse<BlogPost[]>>
```

Get related blog posts for a given post

#### `getRelease` `async`

```typescript
async getRelease(releaseSlug: string): Promise<ApiResponse<Release>>
```

Get a single release by slug

#### `getReleaseFeatures` `async`

```typescript
async getReleaseFeatures(releaseSlug: string): Promise<ApiResponse<ReleaseFeature[]>>
```

Get features for a release (public endpoint)

#### `getReleases` `async`

```typescript
async getReleases(options?: object): Promise<ApiResponse<Release[]>>
```

Get public releases for the project

#### `getRoadmapData` `async`

```typescript
async getRoadmapData(): Promise<ApiResponse<RoadmapData>>
```

Get roadmap data for the project

#### `getSupportTicket` `async`

```typescript
async getSupportTicket(ticketId: string, token: string): Promise<ApiResponse<SupportRequest>>
```

Get a specific support ticket using magic link token

#### `getWish` `async`

```typescript
async getWish(wishId: string): Promise<ApiResponse<Wish>>
```

Get a single wish by ID

#### `searchBlogPosts` `async`

```typescript
async searchBlogPosts(query: string, options?: object): Promise<ApiResponse<BlogPostsResponse>>
```

Search blog posts

#### `sendSupportMagicLink` `async`

```typescript
async sendSupportMagicLink(userEmail: string): Promise<ApiResponse<object>>
```

Request a magic link to access support tickets

#### `submitForm` `async`

```typescript
async submitForm(projectId: string, formId: string, data: FormSubmitInput): Promise<ApiResponse<FormSubmission>>
```

Submit a form

#### `submitSupportRequest` `async`

```typescript
async submitSupportRequest(data: SupportRequestInput): Promise<ApiResponse<SupportRequest>>
```

Submit a support request

#### `submitSurveyResponse` `async`

```typescript
async submitSurveyResponse(surveyId: string, data: SurveySubmitInput): Promise<ApiResponse<SurveyResponse>>
```

Submit a survey response

#### `trackFormView` `async`

```typescript
async trackFormView(formId: string): Promise<ApiResponse<object>>
```

Track a form view (call when form is displayed)

#### `uploadFile` `async`

```typescript
async uploadFile(file: File): Promise<ApiResponse<object>>
```

Upload a file via public portal (no auth required)

#### `verifySupportToken` `async`

```typescript
async verifySupportToken(token: string): Promise<ApiResponse<object>>
```

Verify magic link token and get user's support tickets

---

## useAppgramContext

**Kind:** `hook` | **Access:** `public`

### Declaration

```typescript
function useAppgramContext(): AppgramContextValue
```

### Description

Hook to access the full Appgram context.
Must be used within an AppgramProvider.

---

## useAppgramTheme

**Kind:** `hook` | **Access:** `public`

### Declaration

```typescript
function useAppgramTheme(): AppgramTheme
```

### Description

Hook to access the current theme.
Must be used within an AppgramProvider.

---

## useBlogCategories

**Kind:** `hook` | **Access:** `public`

### Declaration

```typescript
function useBlogCategories(options: UseBlogCategoriesOptions): UseBlogCategoriesResult
```

---

## useBlogPost

**Kind:** `hook` | **Access:** `public`

### Declaration

```typescript
function useBlogPost(options: UseBlogPostOptions): UseBlogPostResult
```

---

## useBlogPosts

**Kind:** `hook` | **Access:** `public`

### Declaration

```typescript
function useBlogPosts(options: UseBlogPostsOptions): UseBlogPostsResult
```

---

## useComments

**Kind:** `hook` | **Access:** `public`

### Declaration

```typescript
function useComments(options: UseCommentsOptions): UseCommentsResult
```

---

## useFeaturedPosts

**Kind:** `hook` | **Access:** `public`

### Declaration

```typescript
function useFeaturedPosts(options: UseFeaturedPostsOptions): UseFeaturedPostsResult
```

---

## useForm

**Kind:** `hook` | **Access:** `public`

### Declaration

```typescript
function useForm(formId: string, options: UseFormOptions): UseFormResult
```

### Description

Fetch a form configuration by ID.

---

## useFormSubmit

**Kind:** `hook` | **Access:** `public`

### Declaration

```typescript
function useFormSubmit(options: UseFormSubmitOptions): UseFormSubmitResult
```

### Description

Submit forms with rate limiting.

---

## useHelpArticle

**Kind:** `hook` | **Access:** `public`

### Declaration

```typescript
function useHelpArticle(slug: string, flowId: string): UseHelpArticleResult
```

### Description

Fetch a specific help article by slug and flow ID.

---

## useHelpCenter

**Kind:** `hook` | **Access:** `public`

### Declaration

```typescript
function useHelpCenter(): UseHelpCenterResult
```

---

## useHelpFlow

**Kind:** `hook` | **Access:** `public`

### Declaration

```typescript
function useHelpFlow(slug: string): UseHelpFlowResult
```

### Description

Fetch a specific help flow by slug.

---

## useRelease

**Kind:** `hook` | **Access:** `public`

### Declaration

```typescript
function useRelease(options: UseReleaseOptions): UseReleaseResult
```

---

## useReleases

**Kind:** `hook` | **Access:** `public`

### Declaration

```typescript
function useReleases(options: UseReleasesOptions): UseReleasesResult
```

---

## useRoadmap

**Kind:** `hook` | **Access:** `public`

### Declaration

```typescript
function useRoadmap(options: UseRoadmapOptions): UseRoadmapResult
```

---

## useStatus

**Kind:** `hook` | **Access:** `public`

### Declaration

```typescript
function useStatus(options: UseStatusOptions): UseStatusResult
```

---

## useSupport

**Kind:** `hook` | **Access:** `public`

### Declaration

```typescript
function useSupport(options: UseSupportOptions): UseSupportResult
```

---

## useSurvey

**Kind:** `hook` | **Access:** `public`

### Declaration

```typescript
function useSurvey(slug: string, options: UseSurveyOptions): UseSurveyResult
```

### Description

Fetch a survey by slug.

---

## useSurveySubmit

**Kind:** `hook` | **Access:** `public`

### Declaration

```typescript
function useSurveySubmit(options: UseSurveySubmitOptions): UseSurveySubmitResult
```

### Description

Submit survey responses.

---

## useVote

**Kind:** `hook` | **Access:** `public`

### Declaration

```typescript
function useVote(options: UseVoteOptions): UseVoteResult
```

---

## useWishes

**Kind:** `hook` | **Access:** `public`

### Declaration

```typescript
function useWishes(options: UseWishesOptions): UseWishesResult
```

---

## Badge

**Kind:** `component` | **Access:** `public`

### Declaration

```typescript
function Badge(props: BadgeProps): ReactElement
```

### Description

Badge Component

A small status indicator with variant support.
Supports muted, success, warning, error, and info actions.

---

## Blog

**Kind:** `component` | **Access:** `public`

### Declaration

```typescript
function Blog(props: BlogProps): ReactElement
```

### Description

Blog Component

Full-featured blog with list and detail views.
Note: For app navigation, use BlogList and BlogPostDetail separately.

---

## BlogCard

**Kind:** `component` | **Access:** `public`

### Declaration

```typescript
function BlogCard(props: BlogCardProps): ReactElement
```

### Description

BlogCard Component

Modern card with image overlay text.
Supports default, compact, and large variants.

---

## BlogList

**Kind:** `component` | **Access:** `public`

### Declaration

```typescript
function BlogList(props: BlogListProps): ReactElement
```

### Description

BlogList Component

Blog list with search, filter, and category pills.
Use this for custom navigation instead of the full Blog component.

---

## BlogPostDetail

**Kind:** `component` | **Access:** `public`

### Declaration

```typescript
function BlogPostDetail(props: BlogPostDetailProps): ReactElement<any, string | JSXElementConstructor<any>> | null
```

### Description

BlogPostDetail Component

Blog detail view with full-width hero image.
Can receive post data directly or fetch by slug.

---

## Button

**Kind:** `component` | **Access:** `public`

### Declaration

```typescript
function Button(props: ButtonProps): ReactElement
```

### Description

Button Component

A styled button with variant support.
Supports solid, outline, and ghost variants with sm, md, lg sizes.

---

## Card

**Kind:** `component` | **Access:** `public`

### Declaration

```typescript
function Card(props: CardProps): ReactElement
```

### Description

Card Component

A styled container with variant support.
Supports default, elevated, and outlined variants.

---

## ChatScreen

**Kind:** `component` | **Access:** `public`

### Declaration

```typescript
function ChatScreen(props: ChatScreenProps): ReactElement
```

### Description

ChatScreen Component

Full-screen AI-powered chat for help center integration.
Queries the help center API and displays responses with sources.

---

## FormRenderer

**Kind:** `component` | **Access:** `public`

### Declaration

```typescript
function FormRenderer(props: FormRendererProps): ReactElement
```

### Description

FormRenderer Component

Renders a dynamic form based on form configuration.
Supports text, email, textarea, checkbox, select, and radio fields.

---

## HelpArticleCard

**Kind:** `component` | **Access:** `public`

### Declaration

```typescript
function HelpArticleCard(props: HelpArticleCardProps): ReactElement
```

### Description

HelpArticleCard Component

A card displaying a help article preview.
Use to build custom help article lists.

---

## HelpArticleDetail

**Kind:** `component` | **Access:** `public`

### Declaration

```typescript
function HelpArticleDetail(props: HelpArticleDetailProps): ReactElement
```

### Description

HelpArticleDetail Component

Displays help article content with HTML rendering.
Use with your app's navigation.

---

## HelpCenter

**Kind:** `component` | **Access:** `public`

### Declaration

```typescript
function HelpCenter(props: HelpCenterProps): ReactElement
```

### Description

HelpCenter Component

Displays help center flows/collections list.
Use onFlowPress to navigate to flow detail in your app.

---

## HelpFlowCard

**Kind:** `component` | **Access:** `public`

### Declaration

```typescript
function HelpFlowCard(props: HelpFlowCardProps): ReactElement
```

### Description

HelpFlowCard Component

A card displaying a help flow/collection.
Use to build custom help center navigation.

---

## HelpFlowDetail

**Kind:** `component` | **Access:** `public`

### Declaration

```typescript
function HelpFlowDetail(props: HelpFlowDetailProps): ReactElement
```

### Description

HelpFlowDetail Component

Displays articles within a help flow/collection.
Use with your app's navigation.

---

## Input

**Kind:** `component` | **Access:** `public`

### Declaration

```typescript
function Input(props: InputProps): ReactElement
```

### Description

Input Component

A styled text input with label and error support.
Automatically shows focus and error states.

---

## ReleaseDetail

**Kind:** `component` | **Access:** `public`

### Declaration

```typescript
function ReleaseDetail(props: ReleaseDetailProps): Element | null
```

### Description

ReleaseDetail Component

Displays a single release with its description, features, and changelog items.
Can receive release data directly or fetch by slug.

---

## ReleaseList

**Kind:** `component` | **Access:** `public`

### Declaration

```typescript
function ReleaseList(props: ReleaseListProps): Element
```

### Description

ReleaseList Component

A list of product releases with version badges and dates.
Use this for custom navigation instead of the full Releases component.

---

## Releases

**Kind:** `component` | **Access:** `public`

### Declaration

```typescript
function Releases(props: ReleasesProps): Element
```

### Description

Releases Component

A timeline-style changelog displaying product releases with features, improvements, and bugfixes.

---

## RoadmapBoard

**Kind:** `component` | **Access:** `public`

### Declaration

```typescript
function RoadmapBoard(props: RoadmapBoardProps): Element
```

### Description

RoadmapBoard Component

A horizontal scrollable Kanban-style roadmap displaying columns and items.
Tapping an item opens the WishDetailModal for voting and comments.

---

## StatusBoard

**Kind:** `component` | **Access:** `public`

### Declaration

```typescript
function StatusBoard(props: StatusBoardProps): ReactElement
```

### Description

StatusBoard Component

Displays system status with services and incidents.

---

## SubmitWishSheet

**Kind:** `component` | **Access:** `public`

### Declaration

```typescript
function SubmitWishSheet(props: SubmitWishSheetProps): ReactElement
```

### Description

SubmitWishSheet Component

Bottom sheet/modal for submitting new feature requests.
Supports auto-detection of custom forms from project customization.

---

## SupportForm

**Kind:** `component` | **Access:** `public`

### Declaration

```typescript
function SupportForm(props: SupportFormProps): ReactElement
```

### Description

SupportForm Component

Modern support form with tabs for submitting and tracking support tickets.
Supports custom contact forms with dynamic field rendering.

---

## SurveyForm

**Kind:** `component` | **Access:** `public`

### Declaration

```typescript
function SurveyForm(props: SurveyFormProps): Element | null
```

### Description

SurveyForm Component

Interactive survey form with decision tree branching support.
Supports yes/no branching, conditional branches, and result messages.

---

## VoteButton

**Kind:** `component` | **Access:** `public`

### Declaration

```typescript
function VoteButton(props: VoteButtonProps): ReactElement
```

### Description

VoteButton Component

An upvote button for wishes with optimistic updates.

---

## WishCard

**Kind:** `component` | **Access:** `public`

### Declaration

```typescript
function WishCard(props: WishCardProps): ReactElement
```

### Description

WishCard Component

A card displaying a wish/feature request with voting and status.

---

## WishDetailModal

**Kind:** `component` | **Access:** `public`

### Declaration

```typescript
function WishDetailModal(props: WishDetailModalProps): ReactElement<any, string | JSXElementConstructor<any>> | null
```

### Description

WishDetailModal Component

A bottom sheet modal displaying wish details, voting, and comments.
Supports swipe-to-dismiss and inline comment submission.

---

## WishList

**Kind:** `component` | **Access:** `public`

### Declaration

```typescript
function WishList(props: WishListProps): ReactElement
```

### Description

WishList Component

A list of wishes with header, submit button, and empty states.
Includes built-in SubmitWishSheet for submitting new feature requests.

---

## SubmitWishSheetProps

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface SubmitWishSheetProps
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `customFormId` | `string` | Custom form ID to use instead of default form. When provided, fetches the form config and renders its fields dynamically. The form should have integration.type = 'wish' to create feature requests. |
| `description` | `string` | Form description |
| `onClose` | `() => void` | Callback when visibility changes |
| `onError` | `(error: string) => void` | Callback when submission fails |
| `onSuccess` | `(wish: Wish) => void` | Callback when wish is successfully submitted |
| `submitButtonText` | `string` | Submit button text |
| `title` | `string` | Form title |
| `visible` | `boolean` | Whether the sheet is visible |

---

## UseVoteOptions

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface UseVoteOptions
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `onError` | `(error: string) => void` | Callback when a vote action fails |
| `onVote` | `(wishId: string, hasVoted: boolean, newCount: number) => void` | Callback when a vote action completes successfully |

---

## UseVoteResult

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface UseVoteResult
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `checkVote` | `(wishId: string) => Promise<object>` | Check if the current user has voted on a wish |
| `error` | `string | null` | Error message if any |
| `isVoting` | `boolean` | Loading state for vote operations |
| `unvote` | `(wishId: string, voteId: string, currentVoteCount: number) => Promise<boolean>` | Remove a vote from a wish |
| `vote` | `(wishId: string, currentVoteCount: number) => Promise<boolean>` | Cast a vote on a wish |

---

## UseWishesOptions

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface UseWishesOptions
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `filters` | `WishFilters` | Initial filters for the wishes query |
| `refreshInterval` | `number` | Auto-refresh interval in milliseconds (0 to disable) |
| `skip` | `boolean` | Skip initial fetch |

---

## UseWishesResult

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface UseWishesResult
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `error` | `string | null` | Error message if any |
| `isLoading` | `boolean` | Loading state |
| `page` | `number` | Current page |
| `refetch` | `() => Promise<void>` | Manually refetch data |
| `setFilters` | `(filters: WishFilters) => void` | Update filters (resets to page 1) |
| `setPage` | `(page: number) => void` | Go to a specific page |
| `total` | `number` | Total number of wishes |
| `totalPages` | `number` | Total pages |
| `wishes` | `Wish[]` | List of wishes |

---

## Vote

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface Vote
```

### Description

Vote Types

### Properties

| Name | Type | Description |
|------|------|-------------|
| `created_at` | `string` |  |
| `fingerprint` | `string` |  |
| `id` | `string` |  |
| `user_id` | `string | null` |  |
| `voter_email` | `string | null` |  |
| `wish_id` | `string` |  |

---

## VoteButtonProps

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface VoteButtonProps
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `initialHasVoted` | `boolean` |  |
| `initialVoteCount` | `number` |  |
| `initialVoteId` | `string` |  |
| `onVoteChange` | `(hasVoted: boolean, newCount: number) => void` |  |
| `size` | `'sm' | 'md' | 'lg'` |  |
| `style` | `ViewStyle` |  |
| `wishId` | `string` |  |

---

## VoteCheckResponse

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface VoteCheckResponse
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `has_voted` | `boolean` |  |
| `vote_id` | `string` |  |

---

## Wish

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface Wish
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `author` | `WishAuthor` |  |
| `author_email` | `string | null` |  |
| `author_name` | `string | null` |  |
| `author_type` | `'user' | 'anonymous' | 'team_member'` |  |
| `category` | `Category | null` |  |
| `category_id` | `string | null` |  |
| `comment_count` | `number` |  |
| `completed_at` | `string | null` |  |
| `created_at` | `string` |  |
| `description` | `string` |  |
| `has_voted` | `boolean` |  |
| `id` | `string` |  |
| `is_pinned` | `boolean` |  |
| `priority` | `WishPriority | null` |  |
| `project_id` | `string` |  |
| `slug` | `string` |  |
| `status` | `WishStatus` |  |
| `title` | `string` |  |
| `updated_at` | `string` |  |
| `vote_count` | `number` |  |

---

## WishAuthor

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface WishAuthor
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `avatar_url` | `string | null` |  |
| `email` | `string | null` |  |
| `name` | `string` |  |

---

## WishCardProps

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface WishCardProps
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `onCommentPress` | `(wish: Wish) => void` |  |
| `onPress` | `(wish: Wish) => void` |  |
| `onVote` | `(wishId: string) => void` |  |
| `style` | `ViewStyle` |  |
| `wish` | `Wish` |  |

---

## WishDetailModalProps

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface WishDetailModalProps
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `onClose` | `() => void` |  |
| `onVote` | `(wishId: string) => void` |  |
| `visible` | `boolean` |  |
| `wish` | `Wish | null` |  |

---

## WishesResponse

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface WishesResponse
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `data` | `Wish[]` |  |
| `page` | `number` |  |
| `per_page` | `number` |  |
| `total` | `number` |  |
| `total_pages` | `number` |  |

---

## WishFilters

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface WishFilters
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `category_id` | `string` |  |
| `fingerprint` | `string` |  |
| `page` | `number` |  |
| `per_page` | `number` |  |
| `priority` | `WishPriority | WishPriority[]` |  |
| `search` | `string` |  |
| `sort_by` | `'votes' | 'created_at' | 'updated_at'` |  |
| `sort_order` | `'asc' | 'desc'` |  |
| `status` | `WishStatus | WishStatus[]` |  |

---

## WishListProps

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface WishListProps
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `contentContainerStyle` | `ViewStyle` |  |
| `customFormId` | `string` | Custom form ID for the submit sheet |
| `description` | `string` |  |
| `emptyText` | `string` |  |
| `filters` | `WishFilters` |  |
| `onAddWish` | `() => void` |  |
| `onCommentPress` | `(wish: Wish) => void` |  |
| `onVote` | `(wishId: string) => void` |  |
| `onWishPress` | `(wish: Wish) => void` |  |
| `onWishSubmitted` | `(wish: Wish) => void` | Callback when a wish is successfully submitted |
| `refreshInterval` | `number` |  |
| `showSubmitButton` | `boolean` | Show the submit idea button (defaults to true) |
| `style` | `ViewStyle` |  |
| `submitButtonText` | `string` | Submit button text |
| `submitSheetDescription` | `string` | Submit sheet description |
| `submitSheetTitle` | `string` | Submit sheet title |
| `title` | `string` |  |

---

## HelpArticle

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface HelpArticle
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `article_type` | `ArticleType` |  |
| `content` | `string` |  |
| `created_at` | `string` |  |
| `excerpt` | `string | null` |  |
| `flow_id` | `string` |  |
| `id` | `string` |  |
| `is_published` | `boolean` |  |
| `published_at` | `string | null` |  |
| `slug` | `string` |  |
| `sort_order` | `number` |  |
| `title` | `string` |  |
| `updated_at` | `string` |  |

---

## HelpArticleCardProps

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface HelpArticleCardProps
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `article` | `HelpArticle` |  |
| `onPress` | `(article: HelpArticle) => void` |  |
| `style` | `ViewStyle` |  |

---

## HelpArticleDetailProps

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface HelpArticleDetailProps
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `article` | `HelpArticle` |  |
| `contentContainerStyle` | `ViewStyle` |  |
| `style` | `ViewStyle` |  |

---

## HelpCenterProps

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface HelpCenterProps
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `contentContainerStyle` | `ViewStyle` |  |
| `description` | `string` |  |
| `emptyText` | `string` |  |
| `numColumns` | `number` |  |
| `onFlowPress` | `(flow: HelpFlow) => void` |  |
| `style` | `ViewStyle` |  |
| `title` | `string` |  |

---

## HelpCollection

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface HelpCollection
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `created_at` | `string` |  |
| `description` | `string | null` |  |
| `flows` | `HelpFlow[]` |  |
| `id` | `string` |  |
| `is_live` | `boolean` |  |
| `name` | `string` |  |
| `project_id` | `string` |  |
| `updated_at` | `string` |  |
| `version` | `string` |  |

---

## HelpFlow

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface HelpFlow
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `articles` | `HelpArticle[]` |  |
| `collection_id` | `string` |  |
| `color` | `string | null` |  |
| `created_at` | `string` |  |
| `description` | `string | null` |  |
| `display_type` | `FlowDisplayType` |  |
| `icon` | `string | null` |  |
| `id` | `string` |  |
| `name` | `string` |  |
| `slug` | `string` |  |
| `sort_order` | `number` |  |
| `updated_at` | `string` |  |

---

## HelpFlowCardProps

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface HelpFlowCardProps
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `flow` | `HelpFlow` |  |
| `onPress` | `(flow: HelpFlow) => void` |  |
| `style` | `ViewStyle` |  |

---

## HelpFlowDetailProps

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface HelpFlowDetailProps
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `contentContainerStyle` | `ViewStyle` |  |
| `emptyText` | `string` |  |
| `flow` | `HelpFlow` |  |
| `onArticlePress` | `(article: HelpArticle) => void` |  |
| `style` | `ViewStyle` |  |

---

## UseHelpArticleResult

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface UseHelpArticleResult
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `article` | `HelpArticle | null` | The help article data |
| `error` | `string | null` | Error message if any |
| `isLoading` | `boolean` | Loading state |
| `refetch` | `() => Promise<void>` | Manually refetch data |

---

## UseHelpCenterResult

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface UseHelpCenterResult
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `collection` | `HelpCollection | null` | The help collection data |
| `error` | `string | null` | Error message if any |
| `flows` | `HelpFlow[]` | List of help flows in this collection |
| `isLoading` | `boolean` | Loading state |
| `refetch` | `() => Promise<void>` | Manually refetch data |

---

## UseHelpFlowResult

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface UseHelpFlowResult
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `error` | `string | null` | Error message if any |
| `flow` | `HelpFlow | null` | The help flow data with its articles |
| `isLoading` | `boolean` | Loading state |
| `refetch` | `() => Promise<void>` | Manually refetch data |

---

## Release

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface Release
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `author_user_id` | `string` |  |
| `content` | `string` |  |
| `cover_image_url` | `string | null` |  |
| `created_at` | `string` |  |
| `excerpt` | `string | null` |  |
| `features` | `ReleaseFeature[]` |  |
| `id` | `string` |  |
| `is_published` | `boolean` |  |
| `items` | `ReleaseItem[]` |  |
| `labels` | `string[]` |  |
| `project_id` | `string` |  |
| `published_at` | `string | null` |  |
| `slug` | `string` |  |
| `title` | `string` |  |
| `updated_at` | `string` |  |
| `version` | `string | null` |  |
| `wish_ids` | `string[]` |  |

---

## ReleaseDetailProps

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface ReleaseDetailProps
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `release` | `Release` |  |
| `releaseSlug` | `string` |  |

---

## ReleaseFeature

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface ReleaseFeature
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `description` | `string` |  |
| `id` | `string` |  |
| `image_url` | `string | null` |  |
| `release_id` | `string` |  |
| `sort_order` | `number` |  |
| `title` | `string` |  |

---

## ReleaseListProps

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface ReleaseListProps
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `description` | `string` |  |
| `limit` | `number` |  |
| `onReleasePress` | `(release: Release) => void` |  |
| `title` | `string` |  |

---

## ReleasesProps

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface ReleasesProps
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `description` | `string` |  |
| `limit` | `number` |  |
| `onReleasePress` | `(release: Release) => void` |  |
| `title` | `string` |  |

---

## UseReleaseOptions

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface UseReleaseOptions
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `releaseSlug` | `string` | The release slug to fetch |
| `skip` | `boolean` | Skip initial fetch |

---

## UseReleaseResult

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface UseReleaseResult
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `error` | `string | null` | Error message if any |
| `features` | `ReleaseFeature[]` | Features included in this release |
| `isLoading` | `boolean` | Loading state |
| `refetch` | `() => Promise<void>` | Manually refetch data |
| `release` | `Release | null` | The release data |

---

## UseReleasesOptions

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface UseReleasesOptions
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `limit` | `number` | Maximum number of releases to fetch |
| `skip` | `boolean` | Skip initial fetch |

---

## UseReleasesResult

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface UseReleasesResult
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `error` | `string | null` | Error message if any |
| `isLoading` | `boolean` | Loading state |
| `refetch` | `() => Promise<void>` | Manually refetch data |
| `releases` | `Release[]` | List of releases |

---

## RoadmapBoardProps

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface RoadmapBoardProps
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `description` | `string` |  |
| `onItemPress` | `(item: RoadmapItem) => void` |  |
| `showVoteCounts` | `boolean` |  |
| `title` | `string` |  |

---

## RoadmapColumn

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface RoadmapColumn
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `color` | `string` |  |
| `created_at` | `string` |  |
| `id` | `string` |  |
| `items` | `RoadmapItem[]` |  |
| `name` | `string` |  |
| `roadmap_id` | `string` |  |
| `sort_order` | `number` |  |
| `updated_at` | `string` |  |
| `wip_limit` | `number | null` |  |

---

## RoadmapData

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface RoadmapData
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `columns` | `RoadmapColumn[]` |  |
| `customization` | `object | null` |  |
| `roadmap` | `Roadmap | null` |  |
| `total_items` | `number` |  |

---

## RoadmapItem

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface RoadmapItem
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `color` | `string | null` |  |
| `column_id` | `string` |  |
| `comment_count` | `number` |  |
| `created_at` | `string` |  |
| `description` | `string | null` |  |
| `id` | `string` |  |
| `roadmap_id` | `string` |  |
| `sort_order` | `number` |  |
| `target_date` | `string | null` |  |
| `title` | `string` |  |
| `updated_at` | `string` |  |
| `vote_count` | `number` |  |
| `wish` | `Wish | null` |  |
| `wish_id` | `string | null` |  |

---

## UseRoadmapOptions

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface UseRoadmapOptions
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `refreshInterval` | `number` | Auto-refresh interval in milliseconds (0 to disable) |
| `skip` | `boolean` | Skip initial fetch |

---

## UseRoadmapResult

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface UseRoadmapResult
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `columns` | `RoadmapColumn[]` | Roadmap columns with items |
| `error` | `string | null` | Error message if any |
| `isLoading` | `boolean` | Loading state |
| `refetch` | `() => Promise<void>` | Manually refetch data |
| `roadmap` | `RoadmapData | null` | Full roadmap data object |
| `totalItems` | `number` | Total number of items across all columns |

---

## StatusBoardProps

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface StatusBoardProps
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `onIncidentPress` | `(incidentId: string) => void` |  |
| `onSubscribe` | `() => void` |  |
| `refreshInterval` | `number` |  |
| `slug` | `string` |  |
| `style` | `ViewStyle` |  |
| `subtitle` | `string` |  |
| `title` | `string` |  |

---

## StatusPage

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface StatusPage
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `created_at` | `string` |  |
| `description` | `string | null` |  |
| `id` | `string` |  |
| `is_active` | `boolean` |  |
| `name` | `string` |  |
| `project_id` | `string` |  |
| `slug` | `string` |  |
| `updated_at` | `string` |  |

---

## StatusPageOverview

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface StatusPageOverview
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `active_count` | `number` |  |
| `active_updates` | `StatusUpdate[]` |  |
| `current_status` | `StatusType` |  |
| `recent_updates` | `StatusUpdate[]` |  |
| `resolved_count` | `number` |  |
| `services` | `StatusPageService[]` |  |
| `services_status` | `Record<string, StatusType>` |  |
| `status_breakdown` | `Record<string, number>` |  |
| `status_page` | `StatusPage` |  |
| `total_updates` | `number` |  |

---

## StatusPageService

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface StatusPageService
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `color` | `string | null` |  |
| `created_at` | `string` |  |
| `description` | `string | null` |  |
| `group_name` | `string | null` |  |
| `id` | `string` |  |
| `is_active` | `boolean` |  |
| `name` | `string` |  |
| `sort_order` | `number` |  |
| `status_page_id` | `string` |  |
| `updated_at` | `string` |  |

---

## UseStatusOptions

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface UseStatusOptions
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `refreshInterval` | `number` | Auto-refresh interval in milliseconds (0 to disable) |
| `slug` | `string` | Status page slug |

---

## UseStatusResult

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface UseStatusResult
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `data` | `StatusPageOverview | null` | Status page data including services and incidents |
| `error` | `string | null` | Error message if any |
| `isLoading` | `boolean` | Loading state |
| `refetch` | `() => Promise<void>` | Manually refetch data |

---

## StoredTicket

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface StoredTicket
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `access_token` | `string` | Access token for viewing the ticket |
| `created_at` | `string` | Creation timestamp |
| `id` | `string` | Ticket ID |
| `magic_link` | `string` | Magic link for authentication (optional) |
| `status` | `string` | Ticket status |
| `subject` | `string` | Ticket subject |
| `user_email` | `string` | User email |

---

## SupportAttachment

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface SupportAttachment
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `mime_type` | `string` |  |
| `name` | `string` |  |
| `size` | `number` |  |
| `url` | `string` |  |

---

## SupportFormProps

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface SupportFormProps
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `checkDescription` | `string` | Check status section description |
| `checkTitle` | `string` | Check status section title |
| `customFormId` | `string` | Custom contact form ID to use instead of default support form. When provided, fetches the form config and renders its fields dynamically. The form should have integration.type = 'support' to create tickets. |
| `description` | `string` | Page description |
| `externalUserId` | `string` | External user ID for tracking |
| `heading` | `string` | Page heading |
| `onCheckStatus` | `(email: string) => void` | Callback when checking status |
| `onError` | `(error: string) => void` | Callback when submission fails |
| `onSuccess` | `(ticket: SupportRequest) => void` | Callback when ticket is successfully submitted |
| `onTicketClick` | `(ticket: SupportRequest) => void` | Callback when a ticket is clicked |
| `showCategory` | `boolean` | Show category selector |
| `showCheckStatus` | `boolean` | Show check status tab |
| `showName` | `boolean` | Show name field |
| `submitButtonText` | `string` | Submit button text |
| `submitDescription` | `string` | Submit section description |
| `submitTitle` | `string` | Submit section title |
| `userEmail` | `string` | Pre-filled user email |
| `userName` | `string` | Pre-filled user name |

---

## SupportMessage

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface SupportMessage
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `attachments` | `SupportAttachment[]` |  |
| `author_email` | `string | null` |  |
| `author_name` | `string | null` |  |
| `author_type` | `'user' | 'team_member'` |  |
| `author_user_id` | `string | null` |  |
| `content` | `string` |  |
| `created_at` | `string` |  |
| `id` | `string` |  |
| `is_internal` | `boolean` |  |
| `support_request_id` | `string` |  |

---

## SupportRequest

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface SupportRequest
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `assignee_id` | `string | null` |  |
| `attachments` | `SupportAttachment[]` |  |
| `category` | `SupportRequestCategory | null` |  |
| `created_at` | `string` |  |
| `description` | `string` |  |
| `id` | `string` |  |
| `message_count` | `number` |  |
| `messages` | `SupportMessage[]` |  |
| `priority` | `SupportRequestPriority | null` |  |
| `project_id` | `string` |  |
| `resolved_at` | `string | null` |  |
| `status` | `SupportRequestStatus` |  |
| `subject` | `string` |  |
| `updated_at` | `string` |  |
| `user_email` | `string` |  |
| `user_name` | `string | null` |  |

---

## SupportRequestInput

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface SupportRequestInput
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `attachments` | `File[]` |  |
| `category` | `SupportRequestCategory` |  |
| `description` | `string` |  |
| `external_user_id` | `string` |  |
| `subject` | `string` |  |
| `user_email` | `string` |  |
| `user_name` | `string` |  |

---

## SupportSubmitData

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface SupportSubmitData
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `category` | `SupportRequestCategory` | Ticket category (optional) |
| `description` | `string` | Ticket description/body |
| `external_user_id` | `string` | External user ID for tracking (optional) |
| `subject` | `string` | Ticket subject |
| `user_email` | `string` | User's email address |
| `user_name` | `string` | User's name (optional) |

---

## UseSupportOptions

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface UseSupportOptions
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `onError` | `(error: string) => void` | Callback when an error occurs |
| `onSuccess` | `(ticket: SupportRequest) => void` | Callback when ticket is submitted successfully |

---

## UseSupportResult

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface UseSupportResult
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `clearMessages` | `() => void` | Clear error and success messages |
| `clearStoredTickets` | `() => Promise<void>` | Clear all locally stored tickets |
| `error` | `string | null` | Error message if any operation failed |
| `isSendingMagicLink` | `boolean` | Loading state while sending magic link |
| `isSubmitting` | `boolean` | Loading state during submission |
| `isVerifying` | `boolean` | Loading state while verifying token |
| `loadStoredTickets` | `() => Promise<void>` | Reload stored tickets from local storage |
| `requestMagicLink` | `(email: string) => Promise<boolean>` | Request a magic link to be sent to the user's email |
| `storedTickets` | `StoredTicket[]` | Locally stored tickets from previous submissions |
| `submitTicket` | `(data: SupportSubmitData) => Promise<SupportRequest | null>` | Submit a support ticket |
| `successMessage` | `string | null` | Success message after successful operations |
| `verifyToken` | `(token: string) => Promise<object | null>` | Verify a magic link token to get user's tickets |

---

## Survey

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface Survey
```

### Description

Survey

### Properties

| Name | Type | Description |
|------|------|-------------|
| `created_at` | `string` |  |
| `description` | `string` |  |
| `id` | `string` |  |
| `is_active` | `boolean` |  |
| `name` | `string` |  |
| `nodes` | `SurveyNode[]` |  |
| `number_of_questions` | `number` |  |
| `number_of_responses` | `number` |  |
| `project_id` | `string` |  |
| `responses` | `SurveyResponse[]` |  |
| `slug` | `string` |  |
| `updated_at` | `string` |  |

---

## SurveyAnswer

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface SurveyAnswer
```

### Description

Survey Answer

### Properties

| Name | Type | Description |
|------|------|-------------|
| `answer` | `boolean` |  |
| `answer_options` | `string[]` |  |
| `answer_rating` | `number` |  |
| `answer_text` | `string` |  |
| `created_at` | `string` |  |
| `id` | `string` |  |
| `node` | `object` |  |
| `node_id` | `string` |  |
| `response_id` | `string` |  |

---

## SurveyFormProps

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface SurveyFormProps
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `autoAdvance` | `boolean` |  |
| `fingerprint` | `string` |  |
| `onError` | `(error: string) => void` |  |
| `onSuccess` | `() => void` |  |
| `slug` | `string` |  |

---

## SurveyNode

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface SurveyNode
```

### Description

Survey Node

Individual questions or result nodes in a survey decision tree.

### Properties

| Name | Type | Description |
|------|------|-------------|
| `answer_no_node_id` | `string | null` |  |
| `answer_yes_node_id` | `string | null` |  |
| `branches` | `SurveyNodeBranch[]` |  |
| `created_at` | `string` |  |
| `id` | `string` |  |
| `is_required` | `boolean` |  |
| `max_rating` | `number` |  |
| `min_rating` | `number` |  |
| `next_node_id` | `string | null` |  |
| `options` | `SurveyNodeOption[]` |  |
| `parent_id` | `string | null` |  |
| `question` | `string` |  |
| `question_type` | `SurveyQuestionType` |  |
| `result_message` | `string | null` |  |
| `sort_order` | `number` |  |
| `survey_id` | `string` |  |
| `updated_at` | `string` |  |

---

## SurveyNodeOption

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface SurveyNodeOption
```

### Description

Survey Node Option

### Properties

| Name | Type | Description |
|------|------|-------------|
| `label` | `string` |  |
| `value` | `string` |  |

---

## SurveyResponse

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface SurveyResponse
```

### Description

Survey Response

### Properties

| Name | Type | Description |
|------|------|-------------|
| `answers` | `SurveyAnswer[]` |  |
| `created_at` | `string` |  |
| `external_user_id` | `string | null` |  |
| `fingerprint` | `string` |  |
| `id` | `string` |  |
| `metadata` | `Record<string, unknown>` |  |
| `survey_id` | `string` |  |

---

## SurveySubmitInput

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface SurveySubmitInput
```

### Description

Input for submitting a survey response

### Properties

| Name | Type | Description |
|------|------|-------------|
| `answers` | `object[]` |  |
| `external_user_id` | `string` |  |
| `fingerprint` | `string` |  |
| `metadata` | `Record<string, unknown>` |  |

---

## UseSurveyOptions

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface UseSurveyOptions
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `enabled` | `boolean` | Whether to fetch the survey on mount |

---

## UseSurveyResult

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface UseSurveyResult
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `error` | `string | null` | Error message if any |
| `isLoading` | `boolean` | Loading state |
| `nodes` | `SurveyNode[]` | Survey question nodes |
| `refetch` | `() => Promise<void>` | Manually refetch data |
| `survey` | `Survey | null` | The survey data |

---

## UseSurveySubmitOptions

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface UseSurveySubmitOptions
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `onError` | `(error: string) => void` | Callback when submission fails |
| `onSuccess` | `(response: SurveyResponse) => void` | Callback when survey is submitted successfully |

---

## UseSurveySubmitResult

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface UseSurveySubmitResult
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `error` | `string | null` | Error message if submission failed |
| `isSubmitting` | `boolean` | Loading state during submission |
| `submitResponse` | `(surveyId: string, data: SurveySubmitInput) => Promise<SurveyResponse | null>` | Submit a survey response |

---

## BlogCardProps

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface BlogCardProps
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `isBookmarked` | `boolean` |  |
| `onBookmark` | `(post: BlogPost) => void` |  |
| `onPress` | `(post: BlogPost) => void` |  |
| `post` | `BlogPost` |  |
| `style` | `ViewStyle` |  |
| `variant` | `'default' | 'large' | 'compact'` |  |

---

## BlogCategory

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface BlogCategory
```

### Description

Blog/Resources Types

### Properties

| Name | Type | Description |
|------|------|-------------|
| `color` | `string | null` |  |
| `description` | `string | null` |  |
| `id` | `string` |  |
| `name` | `string` |  |
| `post_count` | `number` |  |
| `slug` | `string` |  |

---

## BlogFilters

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface BlogFilters
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `category_slug` | `string` |  |
| `is_featured` | `boolean` |  |
| `page` | `number` |  |
| `per_page` | `number` |  |
| `search` | `string` |  |
| `tag` | `string` |  |

---

## BlogListProps

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface BlogListProps
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `bookmarkedIds` | `string[]` |  |
| `cardVariant` | `'default' | 'large' | 'compact'` |  |
| `description` | `string` |  |
| `initialCategory` | `string` |  |
| `initialSearch` | `string` |  |
| `onBookmark` | `(post: BlogPost) => void` |  |
| `onFilterPress` | `() => void` |  |
| `onPostPress` | `(post: BlogPost) => void` |  |
| `postsPerPage` | `number` |  |
| `renderEmpty` | `() => ReactNode` |  |
| `renderError` | `(error: string, retry: () => void) => ReactNode` |  |
| `renderLoading` | `() => ReactNode` |  |
| `showCategories` | `boolean` |  |
| `showSearch` | `boolean` |  |
| `style` | `ViewStyle` |  |
| `title` | `string` |  |

---

## BlogPost

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface BlogPost
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `author_name` | `string | null` |  |
| `category` | `object` |  |
| `category_id` | `string | null` |  |
| `content` | `string` |  |
| `created_at` | `string` |  |
| `excerpt` | `string | null` |  |
| `id` | `string` |  |
| `is_featured` | `boolean` |  |
| `meta_description` | `string | null` |  |
| `og_image_url` | `string | null` |  |
| `project_id` | `string` |  |
| `published_at` | `string` |  |
| `slug` | `string` |  |
| `tags` | `string[]` |  |
| `title` | `string` |  |
| `updated_at` | `string` |  |
| `view_count` | `number` |  |

---

## BlogPostDetailProps

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface BlogPostDetailProps
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `isBookmarked` | `boolean` |  |
| `onBookmark` | `(post: BlogPost) => void` |  |
| `onRelatedPostPress` | `(post: BlogPost) => void` |  |
| `post` | `BlogPost` |  |
| `postSlug` | `string` |  |
| `renderError` | `(error: string, retry: () => void) => ReactNode` |  |
| `renderLoading` | `() => ReactNode` |  |
| `showRelatedPosts` | `boolean` |  |
| `style` | `ViewStyle` |  |

---

## BlogPostsResponse

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface BlogPostsResponse
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `data` | `BlogPost[]` |  |
| `page` | `number` |  |
| `per_page` | `number` |  |
| `total` | `number` |  |
| `total_pages` | `number` |  |

---

## BlogProps

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface BlogProps
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `bookmarkedIds` | `string[]` |  |
| `cardVariant` | `'default' | 'large' | 'compact'` |  |
| `description` | `string` |  |
| `initialCategory` | `string` |  |
| `initialSearch` | `string` |  |
| `onBackToList` | `() => void` |  |
| `onBookmark` | `(post: BlogPost) => void` |  |
| `onFilterPress` | `() => void` |  |
| `onPostView` | `(post: BlogPost) => void` |  |
| `postsPerPage` | `number` |  |
| `renderEmpty` | `() => ReactNode` |  |
| `renderError` | `(error: string, retry: () => void) => ReactNode` |  |
| `renderLoading` | `() => ReactNode` |  |
| `showCategories` | `boolean` |  |
| `showRelatedPosts` | `boolean` |  |
| `showSearch` | `boolean` |  |
| `style` | `ViewStyle` |  |
| `title` | `string` |  |

---

## UseBlogCategoriesOptions

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface UseBlogCategoriesOptions
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `skip` | `boolean` | Skip initial fetch |

---

## UseBlogCategoriesResult

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface UseBlogCategoriesResult
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `categories` | `BlogCategory[]` | List of blog categories |
| `error` | `string | null` | Error message if any |
| `isLoading` | `boolean` | Loading state |
| `refetch` | `() => Promise<void>` | Manually refetch data |

---

## UseBlogPostOptions

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface UseBlogPostOptions
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `skip` | `boolean` | Skip initial fetch |
| `slug` | `string` | The blog post slug to fetch |

---

## UseBlogPostResult

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface UseBlogPostResult
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `error` | `string | null` | Error message if any |
| `isLoading` | `boolean` | Loading state |
| `post` | `BlogPost | null` | The blog post data |
| `refetch` | `() => Promise<void>` | Manually refetch data |
| `relatedPosts` | `BlogPost[]` | Related posts |

---

## UseBlogPostsOptions

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface UseBlogPostsOptions
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `category` | `string` | Filter by category slug |
| `featured` | `boolean` | Only featured posts |
| `per_page` | `number` | Items per page |
| `refreshInterval` | `number` | Auto-refresh interval in milliseconds |
| `search` | `string` | Search query |
| `skip` | `boolean` | Skip initial fetch |
| `tag` | `string` | Filter by tag |

---

## UseBlogPostsResult

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface UseBlogPostsResult
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `error` | `string | null` | Error message if any |
| `isLoading` | `boolean` | Loading state |
| `page` | `number` | Current page number |
| `posts` | `BlogPost[]` | List of blog posts |
| `refetch` | `() => Promise<void>` | Manually refetch data |
| `setFilters` | `(filters: Partial<UseBlogPostsOptions>) => void` | Update filters (resets to page 1) |
| `setPage` | `(page: number) => void` | Set the current page |
| `total` | `number` | Total number of posts |
| `totalPages` | `number` | Total number of pages |

---

## ApiResponse

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface ApiResponse
```

### Description

API Response wrapper

### Properties

| Name | Type | Description |
|------|------|-------------|
| `data` | `T` |  |
| `error` | `object` |  |
| `success` | `boolean` |  |

---

## AppgramClientConfig

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface AppgramClientConfig
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `baseUrl` | `string` |  |
| `orgSlug` | `string` |  |
| `projectId` | `string` |  |
| `projectSlug` | `string` |  |

---

## AppgramColors

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface AppgramColors
```

### Description

Hazel Design System Colors for React Native

Mobile-optimized color palette based on the Hazel design system.

### Properties

| Name | Type | Description |
|------|------|-------------|
| `accent` | `string` |  |
| `background` | `string` |  |
| `border` | `string` |  |
| `card` | `string` |  |
| `cardForeground` | `string` |  |
| `error` | `string` |  |
| `errorSubtle` | `string` |  |
| `foreground` | `string` |  |
| `info` | `string` |  |
| `infoSubtle` | `string` |  |
| `muted` | `string` |  |
| `mutedForeground` | `string` |  |
| `primary` | `string` |  |
| `secondary` | `string` |  |
| `success` | `string` |  |
| `successSubtle` | `string` |  |
| `warning` | `string` |  |
| `warningSubtle` | `string` |  |

---

## AppgramConfig

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface AppgramConfig
```

### Description

Appgram SDK configuration

### Properties

| Name | Type | Description |
|------|------|-------------|
| `apiUrl` | `string` | Custom API URL (defaults to https://api.appgram.dev) |
| `enableFingerprinting` | `boolean` | Enable device fingerprinting for anonymous voting |
| `orgSlug` | `string` | Organization slug for API routing |
| `projectId` | `string` | Your Appgram project ID (required) |
| `projectSlug` | `string` | Project slug for API routing |
| `theme` | `object` | Theme configuration |

---

## AppgramProviderProps

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface AppgramProviderProps
```

### Description

Props for AppgramProvider

### Properties

| Name | Type | Description |
|------|------|-------------|
| `children` | `ReactNode` | Child components |
| `config` | `AppgramConfig` | SDK configuration |

---

## AppgramTheme

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface AppgramTheme
```

### Description

Complete theme object with colors, spacing, radius, and typography

### Properties

| Name | Type | Description |
|------|------|-------------|
| `colors` | `AppgramColors` | Color palette |
| `isDark` | `boolean` | Whether dark mode is active |
| `mode` | `ThemeMode` | Current theme mode |
| `radius` | `object` | Border radius scale (sm, md, lg, xl, full) |
| `spacing` | `object` | Spacing scale (xs, sm, md, lg, xl, 2xl) |
| `typography` | `object` | Typography scale (xs, sm, base, lg, xl, 2xl, 3xl) |

---

## BadgeProps

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface BadgeProps
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `action` | `'success' | 'error' | 'muted' | 'warning' | 'info'` |  |
| `children` | `ReactNode` |  |
| `size` | `'sm' | 'md' | 'lg'` |  |
| `style` | `ViewStyle` |  |

---

## ButtonProps

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface ButtonProps
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `children` | `ReactNode` |  |
| `disabled` | `boolean` |  |
| `loading` | `boolean` |  |
| `onPress` | `() => void` |  |
| `size` | `'sm' | 'md' | 'lg'` |  |
| `style` | `ViewStyle` |  |
| `textStyle` | `TextStyle` |  |
| `variant` | `'solid' | 'outline' | 'ghost'` |  |

---

## CardProps

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface CardProps
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `children` | `ReactNode` |  |
| `style` | `ViewStyle` |  |
| `variant` | `'default' | 'elevated' | 'outlined'` |  |

---

## Category

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface Category
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `color` | `string` |  |
| `description` | `string | null` |  |
| `icon` | `string | null` |  |
| `id` | `string` |  |
| `name` | `string` |  |
| `slug` | `string` |  |
| `wish_count` | `number` |  |

---

## ChatScreenProps

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface ChatScreenProps
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `accentColor` | `string` | Accent color override |
| `agentName` | `string` | Name of the chat agent |
| `greeting` | `string` | Initial greeting message |
| `onArticlePress` | `(slug: string, source: ChatSource) => void` | Callback when an article source is tapped. Provides the article slug and full source data for flexible routing. |
| `onSupportPress` | `() => void` | Callback when support button is tapped |
| `options` | `QuickOption[]` | Quick reply options shown initially |
| `placeholder` | `string` | Input placeholder text |
| `style` | `ViewStyle` | Custom style for container |
| `subtitle` | `string` | Subtitle shown below greeting |

---

## ChatSource

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface ChatSource
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `article_id` | `string` |  |
| `flow_id` | `string` |  |
| `flow_slug` | `string` |  |
| `similarity` | `number` |  |
| `slug` | `string` |  |
| `title` | `string` |  |
| `type` | `'help_article' | 'blog_post'` | Source type - determines routing behavior |

---

## Comment

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface Comment
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `author_avatar_url` | `string | null` |  |
| `author_name` | `string` |  |
| `author_type` | `'user' | 'anonymous' | 'team_member'` |  |
| `author_user_id` | `string | null` |  |
| `content` | `string` |  |
| `created_at` | `string` |  |
| `id` | `string` |  |
| `is_deleted` | `boolean` |  |
| `is_official` | `boolean` |  |
| `parent_id` | `string | null` |  |
| `replies` | `Comment[]` |  |
| `reply_count` | `number` |  |
| `updated_at` | `string` |  |
| `wish_id` | `string` |  |

---

## CommentAuthor

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface CommentAuthor
```

### Description

Comment Types

### Properties

| Name | Type | Description |
|------|------|-------------|
| `avatar_url` | `string | null` |  |
| `name` | `string` |  |

---

## CommentCreateInput

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface CommentCreateInput
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `author_email` | `string` |  |
| `author_name` | `string` |  |
| `content` | `string` |  |
| `parent_id` | `string` |  |
| `wish_id` | `string` |  |

---

## CommentsResponse

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface CommentsResponse
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `data` | `Comment[]` |  |
| `page` | `number` |  |
| `per_page` | `number` |  |
| `total` | `number` |  |
| `total_pages` | `number` |  |

---

## Form

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface Form
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `createdAt` | `string` |  |
| `description` | `string` |  |
| `emailRecipient` | `string` |  |
| `emailSubject` | `string` |  |
| `enabled` | `boolean` |  |
| `fields` | `FormField[]` |  |
| `id` | `string` |  |
| `integration` | `FormIntegration` | Integration settings for form submission |
| `name` | `string` |  |
| `submitButtonText` | `string` |  |
| `successMessage` | `string` |  |
| `updatedAt` | `string` |  |

---

## FormField

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface FormField
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `id` | `string` |  |
| `label` | `string` |  |
| `options` | `string[]` |  |
| `placeholder` | `string` |  |
| `required` | `boolean` |  |
| `type` | `FormFieldType` |  |
| `validation` | `FormFieldValidation` |  |

---

## FormRendererProps

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface FormRendererProps
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `description` | `string` |  |
| `formId` | `string` |  |
| `onError` | `(error: string) => void` |  |
| `onSuccess` | `() => void` |  |
| `projectId` | `string` |  |
| `style` | `ViewStyle` |  |
| `title` | `string` |  |

---

## FormSubmission

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface FormSubmission
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `data` | `Record<string, string | boolean>` |  |
| `form_id` | `string` |  |
| `id` | `string` |  |
| `project_id` | `string` |  |
| `submitted_at` | `string` |  |

---

## InputProps

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface InputProps
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `accessibilityActions` | `unknown` | Provides an array of custom actions available for accessibility. |
| `accessibilityElementsHidden` | `boolean` | A Boolean value indicating whether the accessibility elements contained within this accessibility element are hidden to the screen reader. |
| `accessibilityHint` | `string` | An accessibility hint helps users understand what will happen when they perform an action on the accessibility element when that result is not obvious from the accessibility label. |
| `accessibilityIgnoresInvertColors` | `boolean` | https://reactnative.dev/docs/accessibility#accessibilityignoresinvertcolorsios |
| `accessibilityLabel` | `string` | Overrides the text that's read by the screen reader when the user interacts with the element. By default, the label is constructed by traversing all the children and accumulating all the Text nodes separated by space. |
| `accessibilityLabelledBy` | `string | string[]` | A reference to another element `nativeID` used to build complex forms. The value of `accessibilityLabelledBy` should match the `nativeID` of the related element. |
| `accessibilityLanguage` | `string` | By using the accessibilityLanguage property, the screen reader will understand which language to use while reading the element's label, value and hint. The provided string value must follow the BCP 47 specification (https://www.rfc-editor.org/info/bcp47). https://reactnative.dev/docs/accessibility#accessibilitylanguage-ios |
| `accessibilityLiveRegion` | `'none' | 'polite' | 'assertive'` | Indicates to accessibility services whether the user should be notified when this view changes. Works for Android API >= 19 only. See http://developer.android.com/reference/android/view/View.html#attr_android:accessibilityLiveRegion for references. |
| `accessibilityRole` | `AccessibilityRole` | Accessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the type of element that is focused on. |
| `accessibilityState` | `AccessibilityState` | Accessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of the element currently focused on. |
| `accessibilityValue` | `AccessibilityValue` | Represents the current value of a component. It can be a textual description of a component's value, or for range-based components, such as sliders and progress bars, it contains range information (minimum, current, and maximum). |
| `accessibilityViewIsModal` | `boolean` | A Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver. |
| `accessible` | `boolean` | When true, indicates that the view is an accessibility element. By default, all the touchable elements are accessible. |
| `allowFontScaling` | `boolean` | Specifies whether fonts should scale to respect Text Size accessibility settings. The default is `true`. |
| `aria-busy` | `boolean` | alias for accessibilityState  see https://reactnative.dev/docs/accessibility#accessibilitystate |
| `aria-checked` | `boolean | 'mixed'` |  |
| `aria-disabled` | `boolean` |  |
| `aria-expanded` | `boolean` |  |
| `aria-hidden` | `boolean` | A value indicating whether the accessibility elements contained within this accessibility element are hidden. |
| `aria-label` | `string` | Alias for accessibilityLabel  https://reactnative.dev/docs/view#accessibilitylabel https://github.com/facebook/react-native/issues/34424 |
| `aria-labelledby` | `string` | Represents the nativeID of the associated label text. When the assistive technology focuses on the component with this props, the text is read aloud. |
| `aria-live` | `'polite' | 'assertive' | 'off'` |  |
| `aria-modal` | `boolean` |  |
| `aria-selected` | `boolean` |  |
| `aria-valuemax` | `number` |  |
| `aria-valuemin` | `number` |  |
| `aria-valuenow` | `number` |  |
| `aria-valuetext` | `string` |  |
| `autoCapitalize` | `'none' | 'sentences' | 'words' | 'characters'` | Can tell TextInput to automatically capitalize certain characters.      characters: all characters,      words: first letter of each word      sentences: first letter of each sentence (default)      none: don't auto capitalize anything  https://reactnative.dev/docs/textinput#autocapitalize |
| `autoComplete` | `'email' | 'name' | 'off' | 'additional-name' | 'address-line1' | 'address-line2' | 'birthdate-day' | 'birthdate-full' | 'birthdate-month' | 'birthdate-year' | 'cc-csc' | 'cc-exp' | 'cc-exp-day' | 'cc-exp-month' | 'cc-exp-year' | 'cc-number' | 'cc-name' | 'cc-given-name' | 'cc-middle-name' | 'cc-family-name' | 'cc-type' | 'country' | 'current-password' | 'family-name' | 'gender' | 'given-name' | 'honorific-prefix' | 'honorific-suffix' | 'name-family' | 'name-given' | 'name-middle' | 'name-middle-initial' | 'name-prefix' | 'name-suffix' | 'new-password' | 'nickname' | 'one-time-code' | 'organization' | 'organization-title' | 'password' | 'password-new' | 'postal-address' | 'postal-address-country' | 'postal-address-extended' | 'postal-address-extended-postal-code' | 'postal-address-locality' | 'postal-address-region' | 'postal-code' | 'street-address' | 'sms-otp' | 'tel' | 'tel-country-code' | 'tel-national' | 'tel-device' | 'url' | 'username' | 'username-new'` | Specifies autocomplete hints for the system, so it can provide autofill. On Android, the system will always attempt to offer autofill by using heuristics to identify the type of content. To disable autocomplete, set autoComplete to off.  The following values work across platforms:  - `additional-name` - `address-line1` - `address-line2` - `cc-number` - `country` - `current-password` - `email` - `family-name` - `given-name` - `honorific-prefix` - `honorific-suffix` - `name` - `new-password` - `off` - `one-time-code` - `postal-code` - `street-address` - `tel` - `username`  The following values work on iOS only:  - `nickname` - `organization` - `organization-title` - `url`  The following values work on Android only:  - `birthdate-day` - `birthdate-full` - `birthdate-month` - `birthdate-year` - `cc-csc` - `cc-exp` - `cc-exp-day` - `cc-exp-month` - `cc-exp-year` - `gender` - `name-family` - `name-given` - `name-middle` - `name-middle-initial` - `name-prefix` - `name-suffix` - `password` - `password-new` - `postal-address` - `postal-address-country` - `postal-address-extended` - `postal-address-extended-postal-code` - `postal-address-locality` - `postal-address-region` - `sms-otp` - `tel-country-code` - `tel-national` - `tel-device` - `username-new` |
| `autoCorrect` | `boolean` | If false, disables auto-correct. The default value is true. |
| `autoFocus` | `boolean` | If true, focuses the input on componentDidMount. The default value is false. |
| `blurOnSubmit` | `boolean` | If true, the text field will blur when submitted. The default value is true. |
| `caretHidden` | `boolean` | If true, caret is hidden. The default value is false. |
| `children` | `ReactNode` |  |
| `clearButtonMode` | `'never' | 'while-editing' | 'unless-editing' | 'always'` | enum('never', 'while-editing', 'unless-editing', 'always') When the clear button should appear on the right side of the text view |
| `clearTextOnFocus` | `boolean` | If true, clears the text field automatically when editing begins |
| `collapsable` | `boolean` | Views that are only used to layout their children or otherwise don't draw anything may be automatically removed from the native hierarchy as an optimization. Set this property to false to disable this optimization and ensure that this View exists in the native view hierarchy. |
| `containerStyle` | `ViewStyle` |  |
| `contextMenuHidden` | `boolean` | If true, context menu is hidden. The default value is false. |
| `cursorColor` | `ColorValue | null` | When provided it will set the color of the cursor (or "caret") in the component. Unlike the behavior of `selectionColor` the cursor color will be set independently from the color of the text selection box. |
| `dataDetectorTypes` | `DataDetectorTypes | DataDetectorTypes[]` | Determines the types of data converted to clickable URLs in the text input. Only valid if `multiline={true}` and `editable={false}`. By default no data types are detected.  You can provide one type or an array of many types.  Possible values for `dataDetectorTypes` are:  - `'phoneNumber'` - `'link'` - `'address'` - `'calendarEvent'` - `'none'` - `'all'` |
| `defaultValue` | `string` | Provides an initial value that will change when the user starts typing. Useful for simple use-cases where you don't want to deal with listening to events and updating the value prop to keep the controlled state in sync. |
| `disableFullscreenUI` | `boolean` | When false, if there is a small amount of space available around a text input (e.g. landscape orientation on a phone),   the OS may choose to have the user edit the text inside of a full screen text input mode. When true, this feature is disabled and users will always edit the text directly inside of the text input. Defaults to false. |
| `editable` | `boolean` | If false, text is not editable. The default value is true. |
| `enablesReturnKeyAutomatically` | `boolean` | If true, the keyboard disables the return key when there is no text and automatically enables it when there is text. The default value is false. |
| `enterKeyHint` | `EnterKeyHintTypeOptions` | Determines what text should be shown to the return key on virtual keyboards. Has precedence over the returnKeyType prop. |
| `error` | `string` |  |
| `focusable` | `boolean` | Whether this `View` should be focusable with a non-touch input device, eg. receive focus with a hardware keyboard. |
| `hasTVPreferredFocus` | `boolean` | *(Apple TV only)* May be set to true to force the Apple TV focus engine to move focus to this view. |
| `hitSlop` | `Insets` | This defines how far a touch event can start away from the view. Typical interface guidelines recommend touch targets that are at least 30 - 40 points/density-independent pixels. If a Touchable view has a height of 20 the touchable height can be extended to 40 with hitSlop={{top: 10, bottom: 10, left: 0, right: 0}} NOTE The touch area never extends past the parent view bounds and the Z-index of sibling views always takes precedence if a touch hits two overlapping views. |
| `id` | `string` | Used to reference react managed views from native code. |
| `importantForAccessibility` | `'auto' | 'yes' | 'no' | 'no-hide-descendants'` | [Android] Controlling if a view fires accessibility events and if it is reported to accessibility services. |
| `importantForAutofill` | `'auto' | 'yes' | 'no' | 'noExcludeDescendants' | 'yesExcludeDescendants'` | Determines whether the individual fields in your app should be included in a view structure for autofill purposes on Android API Level 26+. Defaults to auto. To disable auto complete, use `off`.  *Android Only*  The following values work on Android only:  - `auto` - let Android decide - `no` - not important for autofill - `noExcludeDescendants` - this view and its children aren't important for autofill - `yes` - is important for autofill - `yesExcludeDescendants` - this view is important for autofill but its children aren't |
| `inlineImageLeft` | `string` | If defined, the provided image resource will be rendered on the left. |
| `inlineImagePadding` | `number` | Padding between the inline image, if any, and the text input itself. |
| `inputAccessoryViewID` | `string` | Used to connect to an InputAccessoryView. Not part of react-natives documentation, but present in examples and code. See https://reactnative.dev/docs/inputaccessoryview for more information. |
| `inputMode` | `InputModeOptions` | Works like the inputmode attribute in HTML, it determines which keyboard to open, e.g. numeric and has precedence over keyboardType. |
| `inputStyle` | `TextStyle` |  |
| `isTVSelectable` | `boolean` | *(Apple TV only)* When set to true, this view will be focusable and navigable using the Apple TV remote. |
| `keyboardAppearance` | `'light' | 'dark' | 'default'` | Determines the color of the keyboard. |
| `keyboardType` | `KeyboardTypeOptions` | enum("default", 'numeric', 'email-address', "ascii-capable", 'numbers-and-punctuation', 'url', 'number-pad', 'phone-pad', 'name-phone-pad', 'decimal-pad', 'twitter', 'web-search', 'visible-password') Determines which keyboard to open, e.g.numeric. The following values work across platforms: - default - numeric - email-address - phone-pad The following values work on iOS: - ascii-capable - numbers-and-punctuation - url - number-pad - name-phone-pad - decimal-pad - twitter - web-search The following values work on Android: - visible-password |
| `label` | `string` |  |
| `labelStyle` | `TextStyle` |  |
| `lineBreakStrategyIOS` | `'none' | 'standard' | 'hangul-word' | 'push-out'` | Set line break strategy on iOS. |
| `maxFontSizeMultiplier` | `number | null` | Specifies largest possible scale a font can reach when allowFontScaling is enabled. Possible values: - null/undefined (default): inherit from the parent node or the global default (0) - 0: no max, ignore parent/global default - >= 1: sets the maxFontSizeMultiplier of this node to this value |
| `maxLength` | `number` | Limits the maximum number of characters that can be entered. Use this instead of implementing the logic in JS to avoid flicker. |
| `multiline` | `boolean` | If true, the text input can be multiple lines. The default value is false. |
| `nativeID` | `string` | Used to reference react managed views from native code. |
| `needsOffscreenAlphaCompositing` | `boolean` | Whether this view needs to rendered offscreen and composited with an alpha in order to preserve 100% correct colors and blending behavior. The default (false) falls back to drawing the component and its children with an alpha applied to the paint used to draw each element instead of rendering the full component offscreen and compositing it back with an alpha value. This default may be noticeable and undesired in the case where the View you are setting an opacity on has multiple overlapping elements (e.g. multiple overlapping Views, or text and a background).  Rendering offscreen to preserve correct alpha behavior is extremely expensive and hard to debug for non-native developers, which is why it is not turned on by default. If you do need to enable this property for an animation, consider combining it with renderToHardwareTextureAndroid if the view contents are static (i.e. it doesn't need to be redrawn each frame). If that property is enabled, this View will be rendered off-screen once, saved in a hardware texture, and then composited onto the screen with an alpha each frame without having to switch rendering targets on the GPU. |
| `numberOfLines` | `number` | Sets the number of lines for a TextInput. Use it with multiline set to true to be able to fill the lines. |
| `onAccessibilityAction` | `(event: AccessibilityActionEvent) => void` | When `accessible` is true, the system will try to invoke this function when the user performs an accessibility custom action. |
| `onAccessibilityEscape` | `() => void` | When accessible is true, the system will invoke this function when the user performs the escape gesture (scrub with two fingers). |
| `onAccessibilityTap` | `() => void` | When `accessible` is true, the system will try to invoke this function when the user performs accessibility tap gesture. |
| `onBlur` | `(e: NativeSyntheticEvent<TextInputFocusEventData>) => void` | Callback that is called when the text input is blurred |
| `onChange` | `(e: NativeSyntheticEvent<TextInputChangeEventData>) => void` | Callback that is called when the text input's text changes. |
| `onChangeText` | `(text: string) => void` | Callback that is called when the text input's text changes. Changed text is passed as an argument to the callback handler. |
| `onContentSizeChange` | `(e: NativeSyntheticEvent<TextInputContentSizeChangeEventData>) => void` | Callback that is called when the text input's content size changes. This will be called with `{ nativeEvent: { contentSize: { width, height } } }`.  Only called for multiline text inputs. |
| `onEndEditing` | `(e: NativeSyntheticEvent<TextInputEndEditingEventData>) => void` | Callback that is called when text input ends. |
| `onFocus` | `(e: NativeSyntheticEvent<TextInputFocusEventData>) => void` | Callback that is called when the text input is focused |
| `onKeyPress` | `(e: NativeSyntheticEvent<TextInputKeyPressEventData>) => void` | Callback that is called when a key is pressed. This will be called with  `{ nativeEvent: { key: keyValue } }` where keyValue is 'Enter' or 'Backspace' for respective keys and the typed-in character otherwise including ' ' for space.  Fires before onChange callbacks. Note: on Android only the inputs from soft keyboard are handled, not the hardware keyboard inputs. |
| `onLayout` | `(event: LayoutChangeEvent) => void` | Invoked on mount and layout changes with  {nativeEvent: { layout: {x, y, width, height}}}. |
| `onMagicTap` | `() => void` | When accessible is true, the system will invoke this function when the user performs the magic tap gesture. |
| `onMoveShouldSetResponder` | `(event: GestureResponderEvent) => boolean` | Called for every touch move on the View when it is not the responder: does this view want to "claim" touch responsiveness? |
| `onMoveShouldSetResponderCapture` | `(event: GestureResponderEvent) => boolean` | onStartShouldSetResponder and onMoveShouldSetResponder are called with a bubbling pattern, where the deepest node is called first. That means that the deepest component will become responder when multiple Views return true for *ShouldSetResponder handlers. This is desirable in most cases, because it makes sure all controls and buttons are usable.  However, sometimes a parent will want to make sure that it becomes responder. This can be handled by using the capture phase. Before the responder system bubbles up from the deepest component, it will do a capture phase, firing on*ShouldSetResponderCapture. So if a parent View wants to prevent the child from becoming responder on a touch start, it should have a onStartShouldSetResponderCapture handler which returns true. |
| `onPointerCancel` | `(event: PointerEvent) => void` |  |
| `onPointerCancelCapture` | `(event: PointerEvent) => void` |  |
| `onPointerDown` | `(event: PointerEvent) => void` |  |
| `onPointerDownCapture` | `(event: PointerEvent) => void` |  |
| `onPointerEnter` | `(event: PointerEvent) => void` |  |
| `onPointerEnterCapture` | `(event: PointerEvent) => void` |  |
| `onPointerLeave` | `(event: PointerEvent) => void` |  |
| `onPointerLeaveCapture` | `(event: PointerEvent) => void` |  |
| `onPointerMove` | `(event: PointerEvent) => void` |  |
| `onPointerMoveCapture` | `(event: PointerEvent) => void` |  |
| `onPointerUp` | `(event: PointerEvent) => void` |  |
| `onPointerUpCapture` | `(event: PointerEvent) => void` |  |
| `onPressIn` | `(e: NativeSyntheticEvent<NativeTouchEvent>) => void` | Callback that is called when a touch is engaged. |
| `onPressOut` | `(e: NativeSyntheticEvent<NativeTouchEvent>) => void` | Callback that is called when a touch is released. |
| `onResponderEnd` | `(event: GestureResponderEvent) => void` | If the View returns true and attempts to become the responder, one of the following will happen: |
| `onResponderGrant` | `(event: GestureResponderEvent) => void` | The View is now responding for touch events. This is the time to highlight and show the user what is happening |
| `onResponderMove` | `(event: GestureResponderEvent) => void` | The user is moving their finger |
| `onResponderReject` | `(event: GestureResponderEvent) => void` | Something else is the responder right now and will not release it |
| `onResponderRelease` | `(event: GestureResponderEvent) => void` | Fired at the end of the touch, ie "touchUp" |
| `onResponderStart` | `(event: GestureResponderEvent) => void` |  |
| `onResponderTerminate` | `(event: GestureResponderEvent) => void` | The responder has been taken from the View. Might be taken by other views after a call to onResponderTerminationRequest, or might be taken by the OS without asking (happens with control center/ notification center on iOS) |
| `onResponderTerminationRequest` | `(event: GestureResponderEvent) => boolean` | Something else wants to become responder.  Should this view release the responder? Returning true allows release |
| `onScroll` | `(e: NativeSyntheticEvent<TextInputScrollEventData>) => void` | Invoked on content scroll with  `{ nativeEvent: { contentOffset: { x, y } } }`.  May also contain other properties from ScrollEvent but on Android contentSize is not provided for performance reasons. |
| `onSelectionChange` | `(e: NativeSyntheticEvent<TextInputSelectionChangeEventData>) => void` | Callback that is called when the text input selection is changed. |
| `onStartShouldSetResponder` | `(event: GestureResponderEvent) => boolean` | Does this view want to become responder on the start of a touch? |
| `onStartShouldSetResponderCapture` | `(event: GestureResponderEvent) => boolean` | onStartShouldSetResponder and onMoveShouldSetResponder are called with a bubbling pattern, where the deepest node is called first. That means that the deepest component will become responder when multiple Views return true for *ShouldSetResponder handlers. This is desirable in most cases, because it makes sure all controls and buttons are usable.  However, sometimes a parent will want to make sure that it becomes responder. This can be handled by using the capture phase. Before the responder system bubbles up from the deepest component, it will do a capture phase, firing on*ShouldSetResponderCapture. So if a parent View wants to prevent the child from becoming responder on a touch start, it should have a onStartShouldSetResponderCapture handler which returns true. |
| `onSubmitEditing` | `(e: NativeSyntheticEvent<TextInputSubmitEditingEventData>) => void` | Callback that is called when the text input's submit button is pressed. |
| `onTextInput` | `(e: NativeSyntheticEvent<TextInputTextInputEventData>) => void` | Callback that is called on new text input with the argument  `{ nativeEvent: { text, previousText, range: { start, end } } }`.  This prop requires multiline={true} to be set. |
| `onTouchCancel` | `(event: GestureResponderEvent) => void` |  |
| `onTouchEnd` | `(event: GestureResponderEvent) => void` |  |
| `onTouchEndCapture` | `(event: GestureResponderEvent) => void` |  |
| `onTouchMove` | `(event: GestureResponderEvent) => void` |  |
| `onTouchStart` | `(event: GestureResponderEvent) => void` |  |
| `passwordRules` | `string | null` | Provide rules for your password. For example, say you want to require a password with at least eight characters consisting of a mix of uppercase and lowercase letters, at least one number, and at most two consecutive characters. "required: upper; required: lower; required: digit; max-consecutive: 2; minlength: 8;" |
| `placeholder` | `string` | The string that will be rendered before text input has been entered |
| `placeholderTextColor` | `ColorValue` | The text color of the placeholder string |
| `pointerEvents` | `'none' | 'auto' | 'box-none' | 'box-only'` | In the absence of auto property, none is much like CSS's none value. box-none is as if you had applied the CSS class:  .box-none {   pointer-events: none; } .box-none * {   pointer-events: all; }  box-only is the equivalent of  .box-only {   pointer-events: all; } .box-only * {   pointer-events: none; }  But since pointerEvents does not affect layout/appearance, and we are already deviating from the spec by adding additional modes, we opt to not include pointerEvents on style. On some platforms, we would need to implement it as a className anyways. Using style or not is an implementation detail of the platform. |
| `readOnly` | `boolean` | If `true`, text is not editable. The default value is `false`. |
| `rejectResponderTermination` | `boolean | null` | If `true`, allows TextInput to pass touch events to the parent component. This allows components to be swipeable from the TextInput on iOS, as is the case on Android by default. If `false`, TextInput always asks to handle the input (except when disabled). |
| `removeClippedSubviews` | `boolean` | This is a special performance property exposed by RCTView and is useful for scrolling content when there are many subviews, most of which are offscreen. For this property to be effective, it must be applied to a view that contains many subviews that extend outside its bound. The subviews must also have overflow: hidden, as should the containing view (or one of its superviews). |
| `renderToHardwareTextureAndroid` | `boolean` | Whether this view should render itself (and all of its children) into a single hardware texture on the GPU.  On Android, this is useful for animations and interactions that only modify opacity, rotation, translation, and/or scale: in those cases, the view doesn't have to be redrawn and display lists don't need to be re-executed. The texture can just be re-used and re-composited with different parameters. The downside is that this can use up limited video memory, so this prop should be set back to false at the end of the interaction/animation. |
| `returnKeyLabel` | `string` | Sets the return key to the label. Use it instead of `returnKeyType`. |
| `returnKeyType` | `ReturnKeyTypeOptions` | enum('default', 'go', 'google', 'join', 'next', 'route', 'search', 'send', 'yahoo', 'done', 'emergency-call') Determines how the return key should look. |
| `role` | `Role` | Indicates to accessibility services to treat UI component like a specific role. |
| `scrollEnabled` | `boolean` | If false, scrolling of the text view will be disabled. The default value is true. Only works with multiline={true} |
| `secureTextEntry` | `boolean` | If true, the text input obscures the text entered so that sensitive text like passwords stay secure. The default value is false. |
| `selection` | `object` | The start and end of the text input's selection. Set start and end to the same value to position the cursor. |
| `selectionColor` | `ColorValue` | The highlight (and cursor on ios) color of the text input |
| `selectionState` | `DocumentSelectionState` | See DocumentSelectionState.js, some state that is responsible for maintaining selection information for a document |
| `selectTextOnFocus` | `boolean` | If true, all text will automatically be selected on focus |
| `shouldRasterizeIOS` | `boolean` | Whether this view should be rendered as a bitmap before compositing.  On iOS, this is useful for animations and interactions that do not modify this component's dimensions nor its children; for example, when translating the position of a static view, rasterization allows the renderer to reuse a cached bitmap of a static view and quickly composite it during each frame.  Rasterization incurs an off-screen drawing pass and the bitmap consumes memory. Test and measure when using this property. |
| `showSoftInputOnFocus` | `boolean` | When false, it will prevent the soft keyboard from showing when the field is focused. The default value is true |
| `smartInsertDelete` | `boolean` | If `false`, the iOS system will not insert an extra space after a paste operation neither delete one or two spaces after a cut or delete operation.  The default value is `true`. |
| `spellCheck` | `boolean` | If false, disables spell-check style (i.e. red underlines). The default value is inherited from autoCorrect |
| `testID` | `string` | Used to locate this view in end-to-end tests |
| `textAlign` | `'center' | 'left' | 'right'` | Align the input text to the left, center, or right sides of the input field. |
| `textAlignVertical` | `'auto' | 'center' | 'top' | 'bottom'` | Vertically align text when `multiline` is set to true |
| `textBreakStrategy` | `'simple' | 'highQuality' | 'balanced'` | Set text break strategy on Android API Level 23+, possible values are simple, highQuality, balanced The default value is simple. |
| `textContentType` | `'none' | 'name' | 'nickname' | 'password' | 'username' | 'URL' | 'addressCity' | 'addressCityAndState' | 'addressState' | 'countryName' | 'creditCardNumber' | 'creditCardExpiration' | 'creditCardExpirationMonth' | 'creditCardExpirationYear' | 'creditCardSecurityCode' | 'creditCardType' | 'creditCardName' | 'creditCardGivenName' | 'creditCardMiddleName' | 'creditCardFamilyName' | 'emailAddress' | 'familyName' | 'fullStreetAddress' | 'givenName' | 'jobTitle' | 'location' | 'middleName' | 'namePrefix' | 'nameSuffix' | 'organizationName' | 'postalCode' | 'streetAddressLine1' | 'streetAddressLine2' | 'sublocality' | 'telephoneNumber' | 'newPassword' | 'oneTimeCode' | 'birthdate' | 'birthdateDay' | 'birthdateMonth' | 'birthdateYear'` | Give the keyboard and the system information about the expected semantic meaning for the content that users enter.  To disable autofill, set textContentType to `none`.  Possible values for `textContentType` are:   - `'none'`  - `'URL'`  - `'addressCity'`  - `'addressCityAndState'`  - `'addressState'`  - `'countryName'`  - `'creditCardNumber'`  - `'creditCardExpiration'` (iOS 17+)  - `'creditCardExpirationMonth'` (iOS 17+)  - `'creditCardExpirationYear'` (iOS 17+)  - `'creditCardSecurityCode'` (iOS 17+)  - `'creditCardType'` (iOS 17+)  - `'creditCardName'` (iOS 17+)  - `'creditCardGivenName'` (iOS 17+)  - `'creditCardMiddleName'` (iOS 17+)  - `'creditCardFamilyName'` (iOS 17+)  - `'emailAddress'`  - `'familyName'`  - `'fullStreetAddress'`  - `'givenName'`  - `'jobTitle'`  - `'location'`  - `'middleName'`  - `'name'`  - `'namePrefix'`  - `'nameSuffix'`  - `'nickname'`  - `'organizationName'`  - `'postalCode'`  - `'streetAddressLine1'`  - `'streetAddressLine2'`  - `'sublocality'`  - `'telephoneNumber'`  - `'username'`  - `'password'`  - `'newPassword'`  - `'oneTimeCode'`  - `'birthdate'` (iOS 17+)  - `'birthdateDay'` (iOS 17+)  - `'birthdateMonth'` (iOS 17+)  - `'birthdateYear'` (iOS 17+) |
| `tvParallaxMagnification` | `number` | *(Apple TV only)* May be used to change the appearance of the Apple TV parallax effect when this view goes in or out of focus.  Defaults to 1.0. |
| `tvParallaxProperties` | `TVParallaxProperties` | *(Apple TV only)* Object with properties to control Apple TV parallax effects. |
| `tvParallaxShiftDistanceX` | `number` | *(Apple TV only)* May be used to change the appearance of the Apple TV parallax effect when this view goes in or out of focus.  Defaults to 2.0. |
| `tvParallaxShiftDistanceY` | `number` | *(Apple TV only)* May be used to change the appearance of the Apple TV parallax effect when this view goes in or out of focus.  Defaults to 2.0. |
| `tvParallaxTiltAngle` | `number` | *(Apple TV only)* May be used to change the appearance of the Apple TV parallax effect when this view goes in or out of focus.  Defaults to 0.05. |
| `underlineColorAndroid` | `ColorValue` | The color of the textInput underline. |
| `value` | `string` | The value to show for the text input. TextInput is a controlled component, which means the native value will be forced to match this value prop if provided. For most uses this works great, but in some cases this may cause flickering - one common cause is preventing edits by keeping value the same. In addition to simply setting the same value, either set editable={false}, or set/update maxLength to prevent unwanted edits without flicker. |
| `verticalAlign` | `'auto' | 'top' | 'bottom' | 'middle'` | Vertically align text when `multiline` is set to true |

---

## PaginatedResponse

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface PaginatedResponse
```

### Description

Paginated response wrapper

### Properties

| Name | Type | Description |
|------|------|-------------|
| `data` | `T[]` |  |
| `page` | `number` |  |
| `per_page` | `number` |  |
| `total` | `number` |  |
| `total_pages` | `number` |  |

---

## UseCommentsOptions

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface UseCommentsOptions
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `autoFetch` | `boolean` | Whether to fetch comments automatically on mount |
| `wishId` | `string | null` | The wish ID to fetch comments for |

---

## UseCommentsResult

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface UseCommentsResult
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `addComment` | `(content: string, authorName: string, authorEmail: string) => Promise<boolean>` | Add a new comment |
| `comments` | `Comment[]` | List of comments |
| `error` | `string | null` | Error message if any |
| `isLoading` | `boolean` | Loading state for initial fetch |
| `isSubmitting` | `boolean` | Loading state while submitting a comment |
| `refetch` | `() => Promise<void>` | Manually refetch comments |

---

## UseFeaturedPostsOptions

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface UseFeaturedPostsOptions
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `skip` | `boolean` | Skip initial fetch |

---

## UseFeaturedPostsResult

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface UseFeaturedPostsResult
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `error` | `string | null` | Error message if any |
| `isLoading` | `boolean` | Loading state |
| `posts` | `BlogPost[]` | List of featured blog posts |
| `refetch` | `() => Promise<void>` | Manually refetch data |

---

## UseFormOptions

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface UseFormOptions
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `enabled` | `boolean` | Whether to fetch the form on mount |

---

## UseFormResult

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface UseFormResult
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `error` | `string | null` | Error message if any |
| `form` | `Form | null` | The form configuration |
| `isLoading` | `boolean` | Loading state |
| `refetch` | `() => Promise<void>` | Manually refetch the form |

---

## UseFormSubmitOptions

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface UseFormSubmitOptions
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `onError` | `(error: string) => void` | Callback when submission fails |
| `onSuccess` | `(submission: FormSubmission) => void` | Callback when form is submitted successfully |
| `rateLimitMs` | `number` | Minimum time between submissions in milliseconds |

---

## UseFormSubmitResult

**Kind:** `interface` | **Access:** `public`

### Declaration

```typescript
interface UseFormSubmitResult
```

### Properties

| Name | Type | Description |
|------|------|-------------|
| `clearMessages` | `() => void` | Clear error and success messages |
| `error` | `string | null` | Error message if submission failed |
| `isRateLimited` | `boolean` | Whether the user is rate-limited from submitting |
| `isSubmitting` | `boolean` | Loading state during submission |
| `submitForm` | `(projectId: string, formId: string, data: Record<string, string | boolean>) => Promise<FormSubmission | null>` | Submit the form |
| `successMessage` | `string | null` | Success message after submission |

---

## ArticleType

**Kind:** `type` | **Access:** `public`

### Declaration

```typescript
type ArticleType = 'guide' | 'faq' | 'tutorial'
```

### Description

Help Center Types

### Values

- `guide`
- `faq`
- `tutorial`

---

## FlowDisplayType

**Kind:** `type` | **Access:** `public`

### Declaration

```typescript
type FlowDisplayType = 'list' | 'accordion' | 'decision_tree' | 'wizard'
```

### Values

- `list`
- `accordion`
- `decision_tree`
- `wizard`

---

## FormFieldType

**Kind:** `type` | **Access:** `public`

### Declaration

```typescript
type FormFieldType = 'text' | 'email' | 'textarea' | 'select' | 'radio' | 'checkbox'
```

### Description

Form Types

Configurable forms for collecting user submissions.

### Values

- `text`
- `email`
- `textarea`
- `select`
- `radio`
- `checkbox`

---

## StatusState

**Kind:** `type` | **Access:** `public`

### Declaration

```typescript
type StatusState = 'active' | 'resolved'
```

### Values

- `active`
- `resolved`

---

## StatusType

**Kind:** `type` | **Access:** `public`

### Declaration

```typescript
type StatusType = 'operational' | 'maintenance' | 'degraded_performance' | 'partial_outage' | 'major_outage' | 'incident'
```

### Description

Status Page Types

Types for status page API responses.

### Values

- `operational`
- `maintenance`
- `degraded_performance`
- `partial_outage`
- `major_outage`
- `incident`

---

## SupportRequestCategory

**Kind:** `type` | **Access:** `public`

### Declaration

```typescript
type SupportRequestCategory = 'bug_report' | 'feature_request' | 'general_inquiry' | 'billing' | 'account'
```

### Values

- `bug_report`
- `feature_request`
- `general_inquiry`
- `billing`
- `account`

---

## SupportRequestPriority

**Kind:** `type` | **Access:** `public`

### Declaration

```typescript
type SupportRequestPriority = 'low' | 'medium' | 'high' | 'critical'
```

### Values

- `low`
- `medium`
- `high`
- `critical`

---

## SupportRequestStatus

**Kind:** `type` | **Access:** `public`

### Declaration

```typescript
type SupportRequestStatus = 'new' | 'open' | 'in_progress' | 'resolved' | 'closed'
```

### Description

Support Types

### Values

- `new`
- `open`
- `in_progress`
- `resolved`
- `closed`

---

## SurveyQuestionType

**Kind:** `type` | **Access:** `public`

### Declaration

```typescript
type SurveyQuestionType = 'yes_no' | 'short_answer' | 'paragraph' | 'multiple_choice' | 'checkboxes' | 'rating'
```

### Description

Survey Question Types

### Values

- `yes_no`
- `short_answer`
- `paragraph`
- `multiple_choice`
- `checkboxes`
- `rating`

---

## ThemeMode

**Kind:** `type` | **Access:** `public`

### Declaration

```typescript
type ThemeMode = 'light' | 'dark' | 'system'
```

### Description

Theme mode options

### Values

- `light`
- `dark`
- `system`

---

## WishStatus

**Kind:** `type` | **Access:** `public`

### Declaration

```typescript
type WishStatus = 'pending' | 'under_review' | 'planned' | 'in_progress' | 'completed' | 'declined'
```

### Description

Wish (Feature Request) Types

### Values

- `pending`
- `under_review`
- `planned`
- `in_progress`
- `completed`
- `declined`

---

## getErrorMessage

**Kind:** `function` | **Access:** `public`

### Declaration

```typescript
function getErrorMessage(error: unknown, fallback: string): string
```

### Description

Extract error message from various error types

---

## getFingerprint

**Kind:** `function` | **Access:** `public`

### Declaration

```typescript
function getFingerprint(): string
```

### Description

Get device fingerprint for React Native
Uses platform info, screen dimensions, and a random component

---


*This documentation was auto-generated from the SDK source.*
