Skip to content

Commit a5bc07c

Browse files
liweicheng00liweicheng00
committed
Merge branch 'master' into feat/preview-images
2 parents 64965c9 + a16bc1c commit a5bc07c

25 files changed

+5117
-2959
lines changed

‎README.md

Lines changed: 45 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -208,46 +208,46 @@ fetchMessages({ room, options }) {
208208

209209
## Props API
210210

211-
| <div style="width:230px">Prop</div> | Type | Required | Default |
212-
| ----------------------------------- | ---------------- | -------- | -------------------------------------------------- |
213-
| `height` | String | - | `600px` |
214-
| `current-user-id`(1) | [String, Number] | `true` | - |
215-
| `rooms` | Array | - | `[]` |
216-
| `rooms-order` | String | - | `desc` |
217-
| `loading-rooms`(2) | Boolean | - | `false` |
218-
| `rooms-loaded`(3) | Boolean | - | `false` |
219-
| `room-id`(4) | [String, Number] | - | `null` |
220-
| `load-first-room`(5) | Boolean | - | `true` |
221-
| `rooms-list-opened` | Boolean | - | `true` |
222-
| `messages` | Array | - | `[]` |
223-
| `room-message`(6) | String | - | `null` |
224-
| `messages-loaded`(7) | Boolean | - | `false` |
225-
| `room-actions`(8) | Array | - | `[]` |
226-
| `menu-actions`(9) | Array | - | `[]` |
227-
| `message-actions`(10) | Array | - | (10) |
228-
| `templates-text`(11) | Array | - | `null` |
229-
| `show-search` | Boolean | - | `true` |
230-
| `show-add-room` | Boolean | - | `true` |
231-
| `show-send-icon` | Boolean | - | `true` |
232-
| `show-files` | Boolean | - | `true` |
233-
| `show-audio` | Boolean | - | `true` |
234-
| `audio-bit-rate` | Number | - | `128` |
235-
| `audio-sample-rate` | Number | - | `44100` |
236-
| `show-emojis` | Boolean | - | `true` |
237-
| `show-reaction-emojis` | Boolean | - | `true` |
238-
| `show-new-messages-divider`(12) | Boolean | - | `true` |
239-
| `show-footer`(13) | Boolean | - | `true` |
240-
| `text-messages`(14) | Object | - | `null` |
241-
| `text-formatting`(15) | Boolean | - | `true` |
242-
| `link-options`(16) | Object | - | `{ disabled: false, target: '_blank', rel: null }` |
243-
| `room-info-enabled` (17) | Boolean | - | `false` |
244-
| `textarea-action-enabled`(18) | Boolean | - | `false` |
245-
| `responsive-breakpoint`(19) | Number | - | `900` |
246-
| `single-room`(20) | Boolean | - | `false` |
247-
| `scroll-distance`(21) | Number | - | `60` |
248-
| `theme`(22) | Sring | - | `light` |
249-
| `accepted-files`(23) | String | - | `*` |
250-
| `styles`(24) | Object | - | (23) |
211+
| <div style="width:230px">Prop</div> | Type | Required | Default |
212+
| ----------------------------------- | ---------------- | -------- | ----------------------------------------------------------------------------------------------------------------- |
213+
| `height` | String | - | `600px` |
214+
| `current-user-id`(1) | [String, Number] | `true` | - |
215+
| `rooms` | Array | - | `[]` |
216+
| `rooms-order` | String | - | `desc` |
217+
| `loading-rooms`(2) | Boolean | - | `false` |
218+
| `rooms-loaded`(3) | Boolean | - | `false` |
219+
| `room-id`(4) | [String, Number] | - | `null` |
220+
| `load-first-room`(5) | Boolean | - | `true` |
221+
| `rooms-list-opened` | Boolean | - | `true` |
222+
| `messages` | Array | - | `[]` |
223+
| `room-message`(6) | String | - | `null` |
224+
| `messages-loaded`(7) | Boolean | - | `false` |
225+
| `room-actions`(8) | Array | - | `[]` |
226+
| `menu-actions`(9) | Array | - | `[]` |
227+
| `message-actions`(10) | Array | - | (10) |
228+
| `templates-text`(11) | Array | - | `null` |
229+
| `show-search` | Boolean | - | `true` |
230+
| `show-add-room` | Boolean | - | `true` |
231+
| `show-send-icon` | Boolean | - | `true` |
232+
| `show-files` | Boolean | - | `true` |
233+
| `show-audio` | Boolean | - | `true` |
234+
| `audio-bit-rate` | Number | - | `128` |
235+
| `audio-sample-rate` | Number | - | `44100` |
236+
| `show-emojis` | Boolean | - | `true` |
237+
| `show-reaction-emojis` | Boolean | - | `true` |
238+
| `show-new-messages-divider`(12) | Boolean | - | `true` |
239+
| `show-footer`(13) | Boolean | - | `true` |
240+
| `text-messages`(14) | Object | - | `null` |
241+
| `text-formatting`(15) | Object | - | ` {disabled: false, italic: '_', bold: '*', strike: '~', underline: '°', multilineCode: '```', inlineCode: ' `'}` |
242+
| `link-options`(16) | Object | - | `{ disabled: false, target: '_blank', rel: null }` |
243+
| `room-info-enabled` (17) | Boolean | - | `false` |
244+
| `textarea-action-enabled`(18) | Boolean | - | `false` |
245+
| `responsive-breakpoint`(19) | Number | - | `900` |
246+
| `single-room`(20) | Boolean | - | `false` |
247+
| `scroll-distance`(21) | Number | - | `60` |
248+
| `theme`(22) | Sring | - | `light` |
249+
| `accepted-files`(23) | String | - | `*` |
250+
| `styles`(24) | Object | - | (23) |
251251

252252
**(1)** `current-user-id` is required to display UI and trigger actions according to the user using the chat (ex: messages position on the right, etc.)
253253

@@ -372,7 +372,11 @@ text-messages="{
372372
}"
373373
```
374374

375-
**(15)** `text-formatting` can be used to add text formatting. Currently, bold, italic, strikethrough, underline, inline code and multiline code formatting are available and can be used in conjonction. You can disable text formatting by passing the prop as `:text-formatting="false"`.
375+
**(15)** `text-formatting` can be used to add text formatting. Bold, italic, strikethrough, underline, inline code and multiline code formatting are currently available and can be used in conjonction.
376+
377+
- You can disable text formatting by passing the prop `:text-formatting="{disabled: true}"`.
378+
- You can change markdown characters, for example: `:text-formatting="{italic: '^'}"`
379+
- You can disable a specific markdown character, for example: `:text-formatting="{bold: null}"`
376380

377381
| Style | Syntax | Example | Output |
378382
| ----------------- | --------------- | -------------------------------------- | -------------------------------------- |
@@ -845,7 +849,6 @@ yarn add --save vue
845849
[messagesLoaded]="messagesLoaded"
846850
[showFiles]="true"
847851
[showEmojis]="true"
848-
[textFormatting]="true"
849852
[showReactionEmojis]="true"
850853
[showFooter]="true"
851854
(fetch-messages)="fetchMessages($event.detail[0])"

0 commit comments

Comments
 (0)