Skip to content

fix: export missing base UI components and correct stale JSDoc/comments#3730

Merged
oliverlaz merged 1 commit into
developfrom
fix-missing-ui-exports-and-jsdoc
Jul 15, 2026
Merged

fix: export missing base UI components and correct stale JSDoc/comments#3730
oliverlaz merged 1 commit into
developfrom
fix-missing-ui-exports-and-jsdoc

Conversation

@oliverlaz

@oliverlaz oliverlaz commented Jul 15, 2026

Copy link
Copy Markdown
Member

🎯 Goal

Fix issues surfaced by a documentation audit of the RN v9 docs against the SDK source: several documented base-UI primitives were not exported from the package root, and a few source doc-comments were stale (and were the origin of doc errors).

🛠 Implementation details

Missing package-root exports (documented components/hooks that failed to import from stream-chat-react-native):

  • components/ui/index.ts — export Input, SpeedSettingsButton, GiphyChip
  • components/index.ts — export EmptyList, EmptySearchResult, SearchInput, SelectionCircle (were in UIComponents/index.ts but never re-exported, since components/index.ts cherry-picks UIComponents/* rather than re-exporting the barrel), and useCooldownRemaining

Stale source doc-comments corrected (each caused a corresponding docs bug):

  • contexts/pollContext/pollContext.tsxusePollContext error message referenced a non-existent useCreatePollContext hook
  • contexts/attachmentPickerContext/AttachmentPickerContext.tsx — JSDoc referenced a non-existent setBottomInset setter (the context exposes only topInset/bottomInset values)
  • components/Chat/Chat.tsxuseNativeMultipartUpload JSDoc @default true@default false (matches the runtime default)
  • contexts/channelsContext/ChannelsContext.tsxnumberOfSkeletons comment default 68 (matches the runtime default in ChannelList.tsx)

🎨 UI Changes

None — export additions and doc-comment corrections only. No runtime/UI behavior change.

🧪 Testing

  • tsc --noEmit -p package/tsconfig.json passes clean (0 errors) — confirms all new exports resolve without name collisions.
  • No behavior changes; the exported symbols were already used internally.

☑️ Checklist

  • I have signed the Stream CLA (required)
  • PR targets the develop branch
  • Documentation is updated (companion docs PR: GetStream/docs-content#1435)
  • New code is tested in main example apps, including all possible scenarios
    • SampleApp iOS and Android
    • Expo iOS and Android

Adds missing package-root exports so documented primitives are importable:
- ui: Input, SpeedSettingsButton, GiphyChip
- UIComponents: EmptyList, EmptySearchResult, SearchInput, SelectionCircle
- hook: useCooldownRemaining

Also corrects source doc-comments that misled the SDK docs:
- usePollContext error message referenced a non-existent useCreatePollContext
- AttachmentPickerContext JSDoc referenced a non-existent setBottomInset setter
- Chat useNativeMultipartUpload JSDoc @default true -> false (matches runtime)
- ChannelsContext numberOfSkeletons comment default 6 -> 8 (matches runtime)

Surfaced by the RN v9 documentation audit.
@oliverlaz oliverlaz requested review from isekovanic and szuperaz July 15, 2026 12:56
@Stream-SDK-Bot

Copy link
Copy Markdown
Contributor

SDK Size

title develop branch diff status
js_bundle_size 1978 KB 1980 KB +2180 B 🔴

@oliverlaz oliverlaz merged commit 0a38205 into develop Jul 15, 2026
10 of 11 checks passed
@oliverlaz oliverlaz deleted the fix-missing-ui-exports-and-jsdoc branch July 15, 2026 13:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants