Messagebar Svelte Component

Messagebar Svelte Component

Messagebar Svelte component represents Framework7’s Messagebar component.

Messagebar Components

There are following components included:

Messagebar - main messagebar element
MessagebarSheet - messagebar sheet element
MessagebarSheetImage - messagebar sheet image item
MessagebarSheetItem - messagebar sheet item
MessagebarAttachments - messagebar attachments element
MessagebarAttachment - single messagebar attachment element

Messagebar Properties

Prop	Type	Default	Description
<Messagebar> properties
---	---	---	---
init	boolean	true	Initializes Messagebar
name	string		Textarea “name” attribute
textareaId	string number		Textarea “id” attribute
placeholder	string	Message	Textarea placeholder text
value	string number		Textarea value
readonly	boolean	false	Sets “readonly” textarea attribute
disabled	boolean	false	Sets “disbled” textarea attribute
sendLink	string		Enables Send link and specifies its text. This property will be ignored in case you use `send-link` slot
maxHeight	number		Defines resizeable textarea max height
resizable	bolean	true	Enables resizeable textarea
sheetVisible	boolean	false	Makes messagebar sheet visible/active
attachmentsVisible	boolean	false	Makes messagebar attachments visible/active
resizePage	boolean	true	When enabled, it will resize messages page when messagebar textarea size changed
<MessagebarSheetImage> properties
image	string		Sheet image URL
checked	boolean	false	Indicates whether this sheet image-item is checked or not
<MessagebarAttachment> properties
image	string		Attachment image URL
deletable	boolean	true	Defines whether the attachment is deletable or not. In case of deletable the additional delete button will be rendered

Messagebar Methods

<Messagebar> methods
.clear()	Clear textarea and update/reset its size
.setValue(newValue)	Set messagebar textarea value/text
.getValue()	Return messagebar textarea value
.resize()	Force Messagebar to resize messages page depending on messagebar height/size
.focus()	Focus messagebar textarea
.blur()	Remove focus from messagebar textarea

Messagebar Events

Event	Arguments	Description
<Messagebar> events
---	---	---
change	(event)	Event will be triggered when “change” event occurs on messagebar textarea element
input	(event)	Event will be triggered when “input” event occurs on messagebar textarea element
focus	(event)	Event will be triggered when “focus” event occurs on messagebar textarea element
blur	(event)	Event will be triggered when “blur” event occurs on messagebar textarea element
submit send	(value, clear)	Event will be triggered when user clicks on messagebar “send link”
<MessagebarSheetImage> events
change	(event)	Event will be triggered on sheet item checkbox change
<MessagebarAttachment> events
attachmentClick	(event)	Event will be triggered on attachment click
attachmentDelete	(event)	Event will be triggered on attachment delete button click

Messagebar Slots

Messagebar Svelte component has additional slots for custom elements:

default - element will be inserted in the end of <div class="toolbar-inner">. element
before-area - element will be inserted right before textarea. Messagebar attachments go here
after-area - element will be inserted right after textarea
send-link - element will be inserted inside of send link
before-inner - element will be inserted right before <div class="toolbar-inner">. element
after-inner - element will be inserted right after <div class="toolbar-inner">. element. Messagebar sheet goes here
inner-start - element will be inserted in the beginning of <div class="toolbar-inner">. element
inner-end - element will be inserted in the end of <div class="toolbar-inner">. element. Same as default slot

1. <Messagebar placeholder="Message">
2. <div slot="before-inner">Before inner</div>
3. <div slot="after-inner">After inner</div>
4. <div slot="before-area">Before textarea</div>
5. <div slot="after-area">After textarea</div>
6. <i class="f7-icons" slot="send-link">arrow_up_fill</i>
7. <div>Default slot</div>
8. </Messagebar>

Renders to:

1. <div class="toolbar messagebar">
2. <div>Before inner</div>
3. <div class="toolbar-inner">
4. <div class="messagebar-area">
5. <div>Before textarea</div>
6. <textarea placeholder="Message"></textarea>
7. <div>After textarea</div>
8. </div>
9. <a href="#" class="link">
10. <i class="f7-icons" slot="send-link">arrow_up_fill</i>
11. </a>
12. <div>Default slot</div>
13. </div>
14. <div>After inner</div>
15. </div>

Access To Messagebar Instance

If you use automatic initalization to init Messagebar (with init={true} prop) and need to use its Methods and Properties you can access its initialized instance by calling .instance() component’s method. For example:

1. <Messagebar bind:this={component}>...</Messagebar>

3. <script>
4. let component;

6. // to get instance in some method
7. component.instance()
8. </script>

Examples

Here is how the full example of Messages page where it can be used together with Messages:

1. <Page>
2. <Navbar title="Messages"></Navbar>

4. <Messagebar
5. placeholder={placeholder}
6. bind:this={messagebarComponent}
7. attachmentsVisible={attachmentsVisible}
8. sheetVisible={sheetVisible}
9. value={messageText}
10. onInput={(e) => messageText = e.target.value}
11. >
12. <a class="link icon-only" slot="inner-start" on:click={() => sheetVisible = !sheetVisible}>
13. <Icon
14. ios="f7:camera_fill"
15. aurora="f7:camera_fill"
16. md="material:camera_alt"
17. />
18. </a>
19. <a class="link icon-only" slot="inner-end" on:click={sendMessage}>
20. <Icon
21. ios="f7:arrow_up_circle_fill"
22. aurora="f7:arrow_up_circle_fill"
23. md="material:send"
24. />
25. </a>
26. <MessagebarAttachments>
27. {#each attachments as image, index (index)}
28. <MessagebarAttachment
29. key={index}
30. image={image}
31. onAttachmentDelete={() => deleteAttachment(image)}
32. ></MessagebarAttachment>
33. {/each}
34. </MessagebarAttachments>
35. <MessagebarSheet>
36. {#each images as image, index (index)}
37. <MessagebarSheetImage
38. key={index}
39. image={image}
40. checked={attachments.indexOf(image) >= 0}
41. onChange={handleAttachment}
42. ></MessagebarSheetImage>
43. {/each}
44. </MessagebarSheet>
45. </Messagebar>

47. <Messages>
48. <MessagesTitle><b>Sunday, Feb 9,</b> 12:58</MessagesTitle>
49. {#each messagesData as message, index (index)}
50. <Message
51. type={message.type}
52. image={message.image}
53. name={message.name}
54. avatar={message.avatar}
55. first={isFirstMessage(message, index)}
56. last={isLastMessage(message, index)}
57. tail={isTailMessage(message, index)}
58. htmlText={message.text}
59. />
60. {/each}
61. {#if typingMessage}
62. <Message
63. type="received"
64. typing={true}
65. first={true}
66. last={true}
67. tail={true}
68. header={`${typingMessage.name} is typing`}
69. avatar={typingMessage.avatar}
70. ></Message>
71. {/if}
72. </Messages>
73. </Page>

76. <script>
77. import { onMount, onDestroy } from 'svelte';
78. import { f7, f7ready, Navbar, Page, Messages, MessagesTitle, Message, Messagebar, Icon, MessagebarAttachments, MessagebarAttachment, MessagebarSheet, MessagebarSheetImage } from 'framework7-svelte';

80. let messagebarComponent;
81. let messagebarInstance;

83. let attachments = [];
84. let sheetVisible = false;
85. let typingMessage = null;
86. let messageText = '';
87. let messagesData = [
88. {
89. type: 'sent',
90. text: 'Hi, Kate',
91. },
92. {
93. type: 'sent',
94. text: 'How are you?',
95. },
96. {
97. name: 'Kate',
98. type: 'received',
99. text: 'Hi, I am good!',
100. avatar: 'https://cdn.framework7.io/placeholder/people-100x100-9.jpg',
101. },
102. {
103. name: 'Blue Ninja',
104. type: 'received',
105. text: 'Hi there, I am also fine, thanks! And how are you?',
106. avatar: 'https://cdn.framework7.io/placeholder/people-100x100-7.jpg',
107. },
108. {
109. type: 'sent',
110. text: 'Hey, Blue Ninja! Glad to see you ;)',
111. },
112. {
113. type: 'sent',
114. text: 'Hey, look, cutest kitten ever!',
115. },
116. {
117. type: 'sent',
118. image: 'https://cdn.framework7.io/placeholder/cats-200x260-4.jpg',

120. },
121. {
122. name: 'Kate',
123. type: 'received',
124. text: 'Nice!',
125. avatar: 'https://cdn.framework7.io/placeholder/people-100x100-9.jpg',
126. },
127. {
128. name: 'Kate',
129. type: 'received',
130. text: 'Like it very much!',
131. avatar: 'https://cdn.framework7.io/placeholder/people-100x100-9.jpg',
132. },
133. {
134. name: 'Blue Ninja',
135. type: 'received',
136. text: 'Awesome!',
137. avatar: 'https://cdn.framework7.io/placeholder/people-100x100-7.jpg',
138. },
139. ];
140. let images = [
141. 'https://cdn.framework7.io/placeholder/cats-300x300-1.jpg',
142. 'https://cdn.framework7.io/placeholder/cats-200x300-2.jpg',
143. 'https://cdn.framework7.io/placeholder/cats-400x300-3.jpg',
144. 'https://cdn.framework7.io/placeholder/cats-300x150-4.jpg',
145. 'https://cdn.framework7.io/placeholder/cats-150x300-5.jpg',
146. 'https://cdn.framework7.io/placeholder/cats-300x300-6.jpg',
147. 'https://cdn.framework7.io/placeholder/cats-300x300-7.jpg',
148. 'https://cdn.framework7.io/placeholder/cats-200x300-8.jpg',
149. 'https://cdn.framework7.io/placeholder/cats-400x300-9.jpg',
150. 'https://cdn.framework7.io/placeholder/cats-300x150-10.jpg',
151. ];
152. let people = [
153. {
154. name: 'Kate Johnson',
155. avatar: 'https://cdn.framework7.io/placeholder/people-100x100-9.jpg',
156. },
157. {
158. name: 'Blue Ninja',
159. avatar: 'https://cdn.framework7.io/placeholder/people-100x100-7.jpg',
160. },
161. ];
162. let answers = [
163. 'Yes!',
164. 'No',
165. 'Hm...',
166. 'I am not sure',
167. 'And what about you?',
168. 'May be ;)',
169. 'Lorem ipsum dolor sit amet, consectetur',
170. 'What?',
171. 'Are you sure?',
172. 'Of course',
173. 'Need to think about it',
174. 'Amazing!!!',
175. ];
176. let responseInProgress = false;

178. $: attachmentsVisible = attachments.length > 0;
179. $: placeholder = attachments.length > 0 ? 'Add comment or Send' : 'Message';

181. onMount(() => {
182. f7ready(() => {
183. messagebarInstance = messagebarComponent.instance();
184. });
185. });

187. function isFirstMessage(message, index) {
188. const previousMessage = messagesData[index - 1];
189. if (message.isTitle) return false;
190. if (!previousMessage || previousMessage.type !== message.type || previousMessage.name !== message.name) return true;
191. return false;
192. }
193. function isLastMessage(message, index) {
194. const nextMessage = messagesData[index + 1];
195. if (message.isTitle) return false;
196. if (!nextMessage || nextMessage.type !== message.type || nextMessage.name !== message.name) return true;
197. return false;
198. }
199. function isTailMessage(message, index) {
200. const nextMessage = messagesData[index + 1];
201. if (message.isTitle) return false;
202. if (!nextMessage || nextMessage.type !== message.type || nextMessage.name !== message.name) return true;
203. return false;
204. }
205. function deleteAttachment(image) {
206. const index = attachments.indexOf(image);
207. attachments.splice(index, 1);
208. attachments = attachments;
209. }
210. function handleAttachment(e) {
211. const index = f7.$(e.target).parents('label.checkbox').index();
212. const image = images[index];
213. if (e.target.checked) {
214. // Add to attachments
215. attachments.unshift(image);
216. } else {
217. // Remove from attachments
218. attachments.splice(attachments.indexOf(image), 1);
219. }
220. attachments = attachments;
221. }
222. function sendMessage() {
223. const text = messageText.replace(/\n/g, '<br>').trim();
224. const messagesToSend = [];
225. attachments.forEach((attachment) => {
226. messagesToSend.push({
227. type: 'sent',
228. image: attachment,
229. });
230. });
231. if (text.length) {
232. messagesToSend.push({
233. text,
234. type: 'sent',
235. });
236. }
237. if (messagesToSend.length === 0) {
238. return;
239. }

241. // Reset attachments
242. attachments = [];
243. // Hide sheet
244. sheetVisible = false;
245. // Send message
246. messagesData = [...messagesData, ...messagesToSend];
247. // Clear
248. messageText = '';
249. messagebarInstance.clear();

251. // Focus area
252. if (text.length) messagebarInstance.focus();

254. // Mock response
255. if (responseInProgress) return;
256. responseInProgress = true;

258. setTimeout(() => {
259. const answer = answers[Math.floor(Math.random() * answers.length)];
260. const person = people[Math.floor(Math.random() * people.length)];
261. typingMessage = {
262. name: person.name,
263. avatar: person.avatar,
264. };
265. setTimeout(() => {
266. messagesData = [...messagesData, {
267. text: answer,
268. type: 'received',
269. name: person.name,
270. avatar: person.avatar,
271. }];
272. typingMessage = null;
273. responseInProgress = false;
274. }, 4000);
275. }, 1000);
276. }
277. </script>

← Menu

Messages →