Skip to content
This repository was archived by the owner on May 6, 2022. It is now read-only.

Commit 5648b5f

Browse files
committed
chore: release 0.2.5
1 parent 7661c6a commit 5648b5f

File tree

3 files changed

+41
-41
lines changed

3 files changed

+41
-41
lines changed

README.md

Lines changed: 39 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,7 @@ These functions are available as exports from react-native-spokestack-tray
239239
240240
▸ **listen**(): _Promise‹boolean›_
241241
242-
_Defined in [src/Spokestack.ts:615](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720/src/Spokestack.ts#L615)_
242+
_Defined in [src/Spokestack.ts:615](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a/src/Spokestack.ts#L615)_
243243
244244
Tell Spokestack to start listening.
245245
This will also open the tray.
@@ -260,7 +260,7 @@ await listen()
260260
261261
▸ **stopListening**(): _Promise‹boolean›_
262262
263-
_Defined in [src/Spokestack.ts:635](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720/src/Spokestack.ts#L635)_
263+
_Defined in [src/Spokestack.ts:635](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a/src/Spokestack.ts#L635)_
264264
265265
Tell Spokestack to stop listening with ASR.
266266
@@ -280,7 +280,7 @@ stopListening()
280280
281281
▸ **isListening**(): _boolean_
282282
283-
_Defined in [src/Spokestack.ts:498](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720/src/Spokestack.ts#L498)_
283+
_Defined in [src/Spokestack.ts:498](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a/src/Spokestack.ts#L498)_
284284
285285
Returns whether Spokestack is currently listening with ASR
286286
@@ -302,15 +302,15 @@ if (isListening()) {
302302
303303
• **buttonWidth**? : _number_ (Default: **60**)
304304
305-
_Defined in [src/SpokestackTray.tsx:102](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720/src/SpokestackTray.tsx#L102)_
305+
_Defined in [src/SpokestackTray.tsx:102](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a/src/SpokestackTray.tsx#L102)_
306306
307307
Width (and height) of the mic button
308308
309309
### clientId
310310
311311
• **clientId**: _string_
312312
313-
_Defined in [src/SpokestackTray.tsx:67](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720/src/SpokestackTray.tsx#L67)_
313+
_Defined in [src/SpokestackTray.tsx:67](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a/src/SpokestackTray.tsx#L67)_
314314
315315
Your Spokestack tokens generated in your Spokestack account
316316
at https://spokestack.io/account.
@@ -321,7 +321,7 @@ This is from the "ID" field.
321321
322322
• **clientSecret**: _string_
323323
324-
_Defined in [src/SpokestackTray.tsx:74](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720/src/SpokestackTray.tsx#L74)_
324+
_Defined in [src/SpokestackTray.tsx:74](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a/src/SpokestackTray.tsx#L74)_
325325
326326
Your Spokestack tokens generated in your Spokestack account
327327
at https://spokestack.io/account.
@@ -332,39 +332,39 @@ This is from the "secret" field.
332332
333333
• **closeDelay**? : _number_ (Default: **0**)
334334
335-
_Defined in [src/SpokestackTray.tsx:104](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720/src/SpokestackTray.tsx#L104)_
335+
_Defined in [src/SpokestackTray.tsx:104](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a/src/SpokestackTray.tsx#L104)_
336336
337337
How long to wait to close the tray after speaking (ms)
338338
339339
### `Optional` debug
340340
341341
• **debug**? : _boolean_
342342
343-
_Defined in [src/SpokestackTray.tsx:106](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720/src/SpokestackTray.tsx#L106)_
343+
_Defined in [src/SpokestackTray.tsx:106](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a/src/SpokestackTray.tsx#L106)_
344344
345345
Show debug messages from react-native-spokestack
346346
347347
### `Optional` duration
348348
349349
• **duration**? : _number_ (Default: **500**)
350350
351-
_Defined in [src/SpokestackTray.tsx:108](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720/src/SpokestackTray.tsx#L108)_
351+
_Defined in [src/SpokestackTray.tsx:108](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a/src/SpokestackTray.tsx#L108)_
352352
353353
Duration for the tray animation (ms)
354354
355355
### `Optional` easing
356356
357357
• **easing**? : _EasingFunction_ (Default: **Easing.bezier**)
358358
359-
_Defined in [src/SpokestackTray.tsx:110](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720/src/SpokestackTray.tsx#L110)_
359+
_Defined in [src/SpokestackTray.tsx:110](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a/src/SpokestackTray.tsx#L110)_
360360
361361
Easing function for the tray animation
362362
363363
### `Optional` editTranscript
364364
365365
• **editTranscript**? : _function_
366366
367-
_Defined in [src/SpokestackTray.tsx:115](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720/src/SpokestackTray.tsx#L115)_
367+
_Defined in [src/SpokestackTray.tsx:115](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a/src/SpokestackTray.tsx#L115)_
368368
369369
Edit the transcript before classification
370370
and before the user response bubble is shown.
@@ -383,7 +383,7 @@ and before the user response bubble is shown.
383383
384384
• **exitNodes**? : _string[]_
385385
386-
_Defined in [src/SpokestackTray.tsx:120](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720/src/SpokestackTray.tsx#L120)_
386+
_Defined in [src/SpokestackTray.tsx:120](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a/src/SpokestackTray.tsx#L120)_
387387
388388
All nodes in this array should end
389389
the conversation and close the tray
@@ -392,7 +392,7 @@ the conversation and close the tray
392392
393393
• **fontFamily**? : _string_
394394
395-
_Defined in [src/SpokestackTray.tsx:125](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720/src/SpokestackTray.tsx#L125)_
395+
_Defined in [src/SpokestackTray.tsx:125](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a/src/SpokestackTray.tsx#L125)_
396396
397397
Font to use for "LISTENING...", "LOADING...",
398398
and chat bubble text.
@@ -401,7 +401,7 @@ and chat bubble text.
401401
402402
• **gradientColors**? : _string[]_
403403
404-
_Defined in [src/SpokestackTray.tsx:130](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720/src/SpokestackTray.tsx#L130)_
404+
_Defined in [src/SpokestackTray.tsx:130](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a/src/SpokestackTray.tsx#L130)_
405405
406406
Colors for the linear gradient shown when listening
407407
Can be any number of colors (recommended: 2-3)
@@ -410,7 +410,7 @@ Can be any number of colors (recommended: 2-3)
410410
411411
• **greet**? : _boolean_ (Default: **false**)
412412
413-
_Defined in [src/SpokestackTray.tsx:136](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720/src/SpokestackTray.tsx#L136)_
413+
_Defined in [src/SpokestackTray.tsx:136](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a/src/SpokestackTray.tsx#L136)_
414414
415415
Whether to greet the user with a welcome message
416416
when the tray opens.
@@ -420,7 +420,7 @@ Note: `handleIntent` must respond to the "greet" intent.
420420
421421
• **handleIntent**: _function_
422422
423-
_Defined in [src/SpokestackTray.tsx:84](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720/src/SpokestackTray.tsx#L84)_
423+
_Defined in [src/SpokestackTray.tsx:84](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a/src/SpokestackTray.tsx#L84)_
424424
425425
This function takes an intent from the NLU
426426
and returns an object with a unique conversation
@@ -446,7 +446,7 @@ if sound has been turned off.
446446
447447
• **haptic**? : _boolean_ (Default: **true**)
448448
449-
_Defined in [src/SpokestackTray.tsx:141](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720/src/SpokestackTray.tsx#L141)_
449+
_Defined in [src/SpokestackTray.tsx:141](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a/src/SpokestackTray.tsx#L141)_
450450
451451
Set this to false to disable the haptic
452452
that gets played whenever the tray starts listening.
@@ -455,15 +455,15 @@ that gets played whenever the tray starts listening.
455455
456456
• **minHeight**? : _number_ (Default: **170**)
457457
458-
_Defined in [src/SpokestackTray.tsx:143](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720/src/SpokestackTray.tsx#L143)_
458+
_Defined in [src/SpokestackTray.tsx:143](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a/src/SpokestackTray.tsx#L143)_
459459
460460
Minimum height for the tray
461461
462462
### `Optional` nluModelUrls
463463
464464
• **nluModelUrls**? : _object_
465465
466-
_Defined in [src/SpokestackTray.tsx:151](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720/src/SpokestackTray.tsx#L151)_
466+
_Defined in [src/SpokestackTray.tsx:151](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a/src/SpokestackTray.tsx#L151)_
467467
468468
The URLs of your NLU model files.
469469
These models will be automatically downloaded
@@ -483,7 +483,7 @@ See https://spokestack.io/docs/Concepts/nlu
483483
484484
• **onClose**? : _function_
485485
486-
_Defined in [src/SpokestackTray.tsx:159](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720/src/SpokestackTray.tsx#L159)_
486+
_Defined in [src/SpokestackTray.tsx:159](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a/src/SpokestackTray.tsx#L159)_
487487
488488
Called whenever the tray has closed
489489
@@ -495,7 +495,7 @@ Called whenever the tray has closed
495495
496496
• **onError**? : _function_
497497
498-
_Defined in [src/SpokestackTray.tsx:161](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720/src/SpokestackTray.tsx#L161)_
498+
_Defined in [src/SpokestackTray.tsx:161](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a/src/SpokestackTray.tsx#L161)_
499499
500500
Called whenever there's an error from Spokestack
501501
@@ -513,7 +513,7 @@ Called whenever there's an error from Spokestack
513513
514514
• **onOpen**? : _function_
515515
516-
_Defined in [src/SpokestackTray.tsx:163](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720/src/SpokestackTray.tsx#L163)_
516+
_Defined in [src/SpokestackTray.tsx:163](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a/src/SpokestackTray.tsx#L163)_
517517
518518
Called whenever the tray has opened
519519
@@ -525,15 +525,15 @@ Called whenever the tray has opened
525525
526526
• **orientation**? : _"left" | "right"_
527527
528-
_Defined in [src/SpokestackTray.tsx:167](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720/src/SpokestackTray.tsx#L167)_
528+
_Defined in [src/SpokestackTray.tsx:167](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a/src/SpokestackTray.tsx#L167)_
529529
530530
The tray button can be oriented on either side of the screen
531531
532532
### `Optional` primaryColor
533533
534534
• **primaryColor**? : _string_ (Default: **"**)
535535
536-
_Defined in [src/SpokestackTray.tsx:172](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720/src/SpokestackTray.tsx#L172)_
536+
_Defined in [src/SpokestackTray.tsx:172](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a/src/SpokestackTray.tsx#L172)_
537537
538538
This color is used to theme the tray
539539
and is used in the mic button and speech bubbles.
@@ -542,7 +542,7 @@ and is used in the mic button and speech bubbles.
542542
543543
• **refreshModels**? : _boolean_
544544
545-
_Defined in [src/SpokestackTray.tsx:179](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720/src/SpokestackTray.tsx#L179)_
545+
_Defined in [src/SpokestackTray.tsx:179](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a/src/SpokestackTray.tsx#L179)_
546546
547547
Use this sparingly to refresh the
548548
wakeword and NLU models on device
@@ -553,7 +553,7 @@ wakeword and NLU models on device
553553
554554
• **sayGreeting**? : _boolean_ (Default: **true**)
555555
556-
_Defined in [src/SpokestackTray.tsx:185](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720/src/SpokestackTray.tsx#L185)_
556+
_Defined in [src/SpokestackTray.tsx:185](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a/src/SpokestackTray.tsx#L185)_
557557
558558
Whether to speak the greeting or only display
559559
a chat bubble with the greet message,
@@ -563,55 +563,55 @@ even if sound is on.
563563
564564
• **soundOffImage**? : _React.ReactNode_
565565
566-
_Defined in [src/SpokestackTray.tsx:189](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720/src/SpokestackTray.tsx#L189)_
566+
_Defined in [src/SpokestackTray.tsx:189](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a/src/SpokestackTray.tsx#L189)_
567567
568568
Replace the sound off image by passing an <Image />
569569
570570
### `Optional` soundOnImage
571571
572572
• **soundOnImage**? : _React.ReactNode_
573573
574-
_Defined in [src/SpokestackTray.tsx:187](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720/src/SpokestackTray.tsx#L187)_
574+
_Defined in [src/SpokestackTray.tsx:187](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a/src/SpokestackTray.tsx#L187)_
575575
576576
Replace the sound on image by passing an <Image />
577577
578578
### `Optional` startHeight
579579
580580
• **startHeight**? : _number_ (Default: **220**)
581581
582-
_Defined in [src/SpokestackTray.tsx:191](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720/src/SpokestackTray.tsx#L191)_
582+
_Defined in [src/SpokestackTray.tsx:191](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a/src/SpokestackTray.tsx#L191)_
583583
584584
Starting height for tray
585585
586586
### `Optional` style
587587
588588
• **style**? : _Animated.WithAnimatedValue‹StyleProp‹ViewStyle››_
589589
590-
_Defined in [src/SpokestackTray.tsx:193](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720/src/SpokestackTray.tsx#L193)_
590+
_Defined in [src/SpokestackTray.tsx:193](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a/src/SpokestackTray.tsx#L193)_
591591
592592
This style prop is passed to the tray's container
593593
594594
### `Optional` ttsFormat
595595
596596
• **ttsFormat**? : _TTSFormat_ (Default: **TTSFormat.TEXT**)
597597
598-
_Defined in [src/SpokestackTray.tsx:195](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720/src/SpokestackTray.tsx#L195)_
598+
_Defined in [src/SpokestackTray.tsx:195](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a/src/SpokestackTray.tsx#L195)_
599599
600600
The format for the text passed to Spokestack.synthesize
601601
602602
### `Optional` voice
603603
604604
• **voice**? : _string_ (Default: **"demo-male"**)
605605
606-
_Defined in [src/SpokestackTray.tsx:197](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720/src/SpokestackTray.tsx#L197)_
606+
_Defined in [src/SpokestackTray.tsx:197](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a/src/SpokestackTray.tsx#L197)_
607607
608608
A key for a voice in Spokestack ASR, passed to Spokestack.synthesize
609609
610610
### wakewordModelUrls
611611
612612
• **wakewordModelUrls**: _object_
613613
614-
_Defined in [src/SpokestackTray.tsx:96](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720/src/SpokestackTray.tsx#L96)_
614+
_Defined in [src/SpokestackTray.tsx:96](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a/src/SpokestackTray.tsx#L96)_
615615
616616
The URLs of your wakeword model files.
617617
These models will be automatically downloaded
@@ -715,7 +715,7 @@ spokestackTray.current.say('Here is something for Spokestack to say')
715715
716716
▸ **open**(): _void_
717717
718-
_Defined in [src/SpokestackTray.tsx:586](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720/src/SpokestackTray.tsx#L586)_
718+
_Defined in [src/SpokestackTray.tsx:586](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a/src/SpokestackTray.tsx#L586)_
719719
720720
Open the tray, greet (if applicable), and listen
721721
@@ -727,7 +727,7 @@ Open the tray, greet (if applicable), and listen
727727
728728
▸ **close**(): _void_
729729
730-
_Defined in [src/SpokestackTray.tsx:597](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720/src/SpokestackTray.tsx#L597)_
730+
_Defined in [src/SpokestackTray.tsx:597](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a/src/SpokestackTray.tsx#L597)_
731731
732732
Close the tray, stop listening, and restart wakeword
733733
@@ -739,7 +739,7 @@ Close the tray, stop listening, and restart wakeword
739739
740740
▸ **say**(`input`: string): _Promise‹void›_
741741
742-
_Defined in [src/SpokestackTray.tsx:609](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720/src/SpokestackTray.tsx#L609)_
742+
_Defined in [src/SpokestackTray.tsx:609](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a/src/SpokestackTray.tsx#L609)_
743743
744744
Passes the input to Spokestack.synthesize(),
745745
plays the audio, and adds a speech bubble.
@@ -758,7 +758,7 @@ plays the audio, and adds a speech bubble.
758758
759759
▸ **addBubble**(`bubble`: Bubble): _void_
760760
761-
_Defined in [src/SpokestackTray.tsx:647](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720/src/SpokestackTray.tsx#L647)_
761+
_Defined in [src/SpokestackTray.tsx:647](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a/src/SpokestackTray.tsx#L647)_
762762
763763
Add a bubble (system or user)
764764
to the chat interface
@@ -783,7 +783,7 @@ to the chat interface
783783
784784
▸ **toggleSilent**(): _Promise‹boolean›_
785785
786-
_Defined in [src/SpokestackTray.tsx:659](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720/src/SpokestackTray.tsx#L659)_
786+
_Defined in [src/SpokestackTray.tsx:659](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a/src/SpokestackTray.tsx#L659)_
787787
788788
Toggle silent mode
789789
@@ -795,7 +795,7 @@ Toggle silent mode
795795
796796
▸ **isSilent**(): _boolean_
797797
798-
_Defined in [src/SpokestackTray.tsx:671](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720/src/SpokestackTray.tsx#L671)_
798+
_Defined in [src/SpokestackTray.tsx:671](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a/src/SpokestackTray.tsx#L671)_
799799
800800
Returns whether the tray is in silent mode
801801

package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "react-native-spokestack-tray",
3-
"version": "0.2.4",
3+
"version": "0.2.5",
44
"description": "A React Native component for adding Spokestack to any React Native app",
55
"main": "lib/commonjs/index.js",
66
"module": "lib/module/index.js",

0 commit comments

Comments
 (0)