Skip to content

Commit 61be7da

Browse files
authored
[UIKIT-1680] Fix type defn import for TS projects (#138)
* Add correct TS defn file to scripts as index_d_ts * In index_d_ts: * Remove all imports and exports at top level * Make all types into consts * Add file scripts/steps.md describing release process * Remove scripts/README.md * Fix a missing export in exports.js * Fix a missing variable in EditDetailsModal
1 parent 5edb178 commit 61be7da

File tree

6 files changed

+1844
-104
lines changed

6 files changed

+1844
-104
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@
88
99
We are introducing a new version of the Sendbird Chat UIKit. Version 3 features a new modular architecture with more granular components that give you enhanced flexibility to customize your web and mobile apps. Check out our [migration guides](MIGRATION_v2-to-v3.md).
1010

11+
## Installation
12+
13+
`npm i @sendbird/uikit-react`
14+
15+
For typescript projects, add `node_modules/@sendbird/uikit-react/index.d.ts` to your `include` section in tsconfig file to get type definitions
16+
1117
## Getting Started
1218

1319
With Sendbird UI Kit React, we export these components:

exports.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ export default {
116116
'ui/MessageItemReactionMenu': 'src/ui/MessageItemReactionMenu/index.tsx',
117117
'ui/MessageSearchFileItem': 'src/ui/MessageSearchFileItem/index.tsx',
118118
'ui/MessageSearchItem': 'src/ui/MessageSearchItem/index.tsx',
119-
'ui/MessageStatus': 'src/ui/MessageStatus/index.jsx',
119+
'ui/MessageStatus': 'src/ui/MessageStatus/index.tsx',
120120
'ui/Modal': 'src/ui/Modal/index.jsx',
121121
'ui/OGMessageItemBody': 'src/ui/OGMessageItemBody/index.tsx',
122122
'ui/OpenChannelAdminMessage': 'src/ui/OpenChannelAdminMessage/index.tsx',

scripts/README.md

Lines changed: 0 additions & 103 deletions
This file was deleted.

0 commit comments

Comments
 (0)