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

Commit 7039172

Browse files
committed
chore: release 0.2.3
1 parent b689c1a commit 7039172

File tree

3 files changed

+40
-40
lines changed

3 files changed

+40
-40
lines changed

README.md

Lines changed: 38 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@ These functions are available as exports from react-native-spokestack-tray
218218
219219
▸ **listen**(): _Promise‹boolean›_
220220
221-
_Defined in [src/Spokestack.ts:591](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36/src/Spokestack.ts#L591)_
221+
_Defined in [src/Spokestack.ts:591](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a/src/Spokestack.ts#L591)_
222222
223223
Tell Spokestack to start listening.
224224
This will also open the tray.
@@ -239,7 +239,7 @@ await listen()
239239
240240
▸ **stopListening**(): _Promise‹boolean›_
241241
242-
_Defined in [src/Spokestack.ts:611](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36/src/Spokestack.ts#L611)_
242+
_Defined in [src/Spokestack.ts:611](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a/src/Spokestack.ts#L611)_
243243
244244
Tell Spokestack to stop listening with ASR.
245245
@@ -259,7 +259,7 @@ stopListening()
259259
260260
▸ **isListening**(): _boolean_
261261
262-
_Defined in [src/Spokestack.ts:475](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36/src/Spokestack.ts#L475)_
262+
_Defined in [src/Spokestack.ts:475](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a/src/Spokestack.ts#L475)_
263263
264264
Returns whether Spokestack is currently listening with ASR
265265
@@ -281,15 +281,15 @@ if (isListening()) {
281281
282282
• **buttonWidth**? : _number_ (Default: **60**)
283283
284-
_Defined in [src/SpokestackTray.tsx:90](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36/src/SpokestackTray.tsx#L90)_
284+
_Defined in [src/SpokestackTray.tsx:90](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a/src/SpokestackTray.tsx#L90)_
285285
286286
Width (and height) of the mic button
287287
288288
### clientId
289289
290290
• **clientId**: _string_
291291
292-
_Defined in [src/SpokestackTray.tsx:55](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36/src/SpokestackTray.tsx#L55)_
292+
_Defined in [src/SpokestackTray.tsx:55](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a/src/SpokestackTray.tsx#L55)_
293293
294294
Your Spokestack tokens generated in your Spokestack account
295295
at https://spokestack.io/account.
@@ -300,7 +300,7 @@ This is from the "ID" field.
300300
301301
• **clientSecret**: _string_
302302
303-
_Defined in [src/SpokestackTray.tsx:62](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36/src/SpokestackTray.tsx#L62)_
303+
_Defined in [src/SpokestackTray.tsx:62](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a/src/SpokestackTray.tsx#L62)_
304304
305305
Your Spokestack tokens generated in your Spokestack account
306306
at https://spokestack.io/account.
@@ -311,31 +311,31 @@ This is from the "secret" field.
311311
312312
• **closeDelay**? : _number_ (Default: **0**)
313313
314-
_Defined in [src/SpokestackTray.tsx:92](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36/src/SpokestackTray.tsx#L92)_
314+
_Defined in [src/SpokestackTray.tsx:92](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a/src/SpokestackTray.tsx#L92)_
315315
316316
How long to wait to close the tray after speaking (ms)
317317
318318
### `Optional` duration
319319
320320
• **duration**? : _number_ (Default: **500**)
321321
322-
_Defined in [src/SpokestackTray.tsx:94](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36/src/SpokestackTray.tsx#L94)_
322+
_Defined in [src/SpokestackTray.tsx:94](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a/src/SpokestackTray.tsx#L94)_
323323
324324
Duration for the tray animation (ms)
325325
326326
### `Optional` easing
327327
328328
• **easing**? : _EasingFunction_ (Default: **Easing.bezier**)
329329
330-
_Defined in [src/SpokestackTray.tsx:96](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36/src/SpokestackTray.tsx#L96)_
330+
_Defined in [src/SpokestackTray.tsx:96](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a/src/SpokestackTray.tsx#L96)_
331331
332332
Easing function for the tray animation
333333
334334
### `Optional` editTranscript
335335
336336
• **editTranscript**? : _function_
337337
338-
_Defined in [src/SpokestackTray.tsx:101](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36/src/SpokestackTray.tsx#L101)_
338+
_Defined in [src/SpokestackTray.tsx:101](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a/src/SpokestackTray.tsx#L101)_
339339
340340
Edit the transcript before classification
341341
and before the user response bubble is shown.
@@ -354,7 +354,7 @@ and before the user response bubble is shown.
354354
355355
• **exitNodes**? : _string[]_
356356
357-
_Defined in [src/SpokestackTray.tsx:106](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36/src/SpokestackTray.tsx#L106)_
357+
_Defined in [src/SpokestackTray.tsx:106](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a/src/SpokestackTray.tsx#L106)_
358358
359359
All nodes in this array should end
360360
the conversation and close the tray
@@ -363,7 +363,7 @@ the conversation and close the tray
363363
364364
• **fontFamily**? : _string_
365365
366-
_Defined in [src/SpokestackTray.tsx:111](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36/src/SpokestackTray.tsx#L111)_
366+
_Defined in [src/SpokestackTray.tsx:111](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a/src/SpokestackTray.tsx#L111)_
367367
368368
Font to use for "LISTENING...", "LOADING...",
369369
and chat bubble text.
@@ -372,7 +372,7 @@ and chat bubble text.
372372
373373
• **gradientColors**? : _string[]_
374374
375-
_Defined in [src/SpokestackTray.tsx:116](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36/src/SpokestackTray.tsx#L116)_
375+
_Defined in [src/SpokestackTray.tsx:116](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a/src/SpokestackTray.tsx#L116)_
376376
377377
Colors for the linear gradient shown when listening
378378
Can be any number of colors (recommended: 2-3)
@@ -381,7 +381,7 @@ Can be any number of colors (recommended: 2-3)
381381
382382
• **greet**? : _boolean_ (Default: **false**)
383383
384-
_Defined in [src/SpokestackTray.tsx:122](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36/src/SpokestackTray.tsx#L122)_
384+
_Defined in [src/SpokestackTray.tsx:122](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a/src/SpokestackTray.tsx#L122)_
385385
386386
Whether to greet the user with a welcome message
387387
when the tray opens.
@@ -391,7 +391,7 @@ Default: false
391391
392392
• **handleIntent**: _function_
393393
394-
_Defined in [src/SpokestackTray.tsx:72](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36/src/SpokestackTray.tsx#L72)_
394+
_Defined in [src/SpokestackTray.tsx:72](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a/src/SpokestackTray.tsx#L72)_
395395
396396
This function takes an intent from the NLU
397397
and returns an object with a unique conversation
@@ -417,7 +417,7 @@ if sound has been turned off.
417417
418418
• **haptic**? : _boolean_ (Default: **true**)
419419
420-
_Defined in [src/SpokestackTray.tsx:127](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36/src/SpokestackTray.tsx#L127)_
420+
_Defined in [src/SpokestackTray.tsx:127](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a/src/SpokestackTray.tsx#L127)_
421421
422422
Set this to false to disable the haptic
423423
that gets played whenever the tray starts listening.
@@ -426,15 +426,15 @@ that gets played whenever the tray starts listening.
426426
427427
• **minHeight**? : _number_ (Default: **170**)
428428
429-
_Defined in [src/SpokestackTray.tsx:129](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36/src/SpokestackTray.tsx#L129)_
429+
_Defined in [src/SpokestackTray.tsx:129](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a/src/SpokestackTray.tsx#L129)_
430430
431431
Minimum height for the tray
432432
433433
### `Optional` nluModelUrls
434434
435435
• **nluModelUrls**? : _object_
436436
437-
_Defined in [src/SpokestackTray.tsx:137](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36/src/SpokestackTray.tsx#L137)_
437+
_Defined in [src/SpokestackTray.tsx:137](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a/src/SpokestackTray.tsx#L137)_
438438
439439
The URLs of your NLU model files.
440440
These models will be automatically downloaded
@@ -454,7 +454,7 @@ See https://spokestack.io/docs/Concepts/nlu
454454
455455
• **onClose**? : _function_
456456
457-
_Defined in [src/SpokestackTray.tsx:145](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36/src/SpokestackTray.tsx#L145)_
457+
_Defined in [src/SpokestackTray.tsx:145](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a/src/SpokestackTray.tsx#L145)_
458458
459459
Called whenever the tray has closed
460460
@@ -466,7 +466,7 @@ Called whenever the tray has closed
466466
467467
• **onError**? : _function_
468468
469-
_Defined in [src/SpokestackTray.tsx:147](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36/src/SpokestackTray.tsx#L147)_
469+
_Defined in [src/SpokestackTray.tsx:147](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a/src/SpokestackTray.tsx#L147)_
470470
471471
Called whenever there's an error from Spokestack
472472

@@ -484,7 +484,7 @@ Called whenever there's an error from Spokestack
484484

485485
**onOpen**? : _function_
486486

487-
_Defined in [src/SpokestackTray.tsx:149](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36/src/SpokestackTray.tsx#L149)_
487+
_Defined in [src/SpokestackTray.tsx:149](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a/src/SpokestackTray.tsx#L149)_
488488

489489
Called whenever the tray has opened
490490

@@ -496,15 +496,15 @@ Called whenever the tray has opened
496496

497497
**orientation**? : _"left" | "right"_
498498

499-
_Defined in [src/SpokestackTray.tsx:153](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36/src/SpokestackTray.tsx#L153)_
499+
_Defined in [src/SpokestackTray.tsx:153](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a/src/SpokestackTray.tsx#L153)_
500500

501501
The tray button can be oriented on either side of the screen
502502

503503
### `Optional` primaryColor
504504

505505
**primaryColor**? : _string_ (Default: **"**)
506506
507-
_Defined in [src/SpokestackTray.tsx:158](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36/src/SpokestackTray.tsx#L158)_
507+
_Defined in [src/SpokestackTray.tsx:158](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a/src/SpokestackTray.tsx#L158)_
508508
509509
This color is used to theme the tray
510510
and is used in the mic button and speech bubbles.
@@ -513,7 +513,7 @@ and is used in the mic button and speech bubbles.
513513
514514
• **refreshModels**? : _boolean_
515515
516-
_Defined in [src/SpokestackTray.tsx:165](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36/src/SpokestackTray.tsx#L165)_
516+
_Defined in [src/SpokestackTray.tsx:165](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a/src/SpokestackTray.tsx#L165)_
517517
518518
Use this sparingly to refresh the
519519
wakeword and NLU models on device
@@ -524,7 +524,7 @@ wakeword and NLU models on device
524524
525525
• **sayGreeting**? : _boolean_ (Default: **true**)
526526
527-
_Defined in [src/SpokestackTray.tsx:172](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36/src/SpokestackTray.tsx#L172)_
527+
_Defined in [src/SpokestackTray.tsx:172](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a/src/SpokestackTray.tsx#L172)_
528528
529529
Whether to speak the greeting or only display
530530
a chat bubble with the greet message,
@@ -535,55 +535,55 @@ Default: true
535535
536536
• **soundOffImage**? : _React.ReactNode_
537537
538-
_Defined in [src/SpokestackTray.tsx:176](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36/src/SpokestackTray.tsx#L176)_
538+
_Defined in [src/SpokestackTray.tsx:176](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a/src/SpokestackTray.tsx#L176)_
539539
540540
Replace the sound off image by passing an <Image />
541541
542542
### `Optional` soundOnImage
543543
544544
• **soundOnImage**? : _React.ReactNode_
545545
546-
_Defined in [src/SpokestackTray.tsx:174](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36/src/SpokestackTray.tsx#L174)_
546+
_Defined in [src/SpokestackTray.tsx:174](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a/src/SpokestackTray.tsx#L174)_
547547
548548
Replace the sound on image by passing an <Image />
549549
550550
### `Optional` startHeight
551551
552552
• **startHeight**? : _number_ (Default: **220**)
553553
554-
_Defined in [src/SpokestackTray.tsx:178](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36/src/SpokestackTray.tsx#L178)_
554+
_Defined in [src/SpokestackTray.tsx:178](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a/src/SpokestackTray.tsx#L178)_
555555
556556
Starting height for tray
557557
558558
### `Optional` style
559559
560560
• **style**? : _Animated.WithAnimatedValue‹StyleProp‹ViewStyle››_
561561
562-
_Defined in [src/SpokestackTray.tsx:180](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36/src/SpokestackTray.tsx#L180)_
562+
_Defined in [src/SpokestackTray.tsx:180](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a/src/SpokestackTray.tsx#L180)_
563563
564564
This style prop is passed to the tray's container
565565
566566
### `Optional` ttsFormat
567567
568568
• **ttsFormat**? : _TTSFormat_ (Default: **TTSFormat.TEXT**)
569569
570-
_Defined in [src/SpokestackTray.tsx:182](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36/src/SpokestackTray.tsx#L182)_
570+
_Defined in [src/SpokestackTray.tsx:182](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a/src/SpokestackTray.tsx#L182)_
571571
572572
The format for the text passed to Spokestack.synthesize
573573
574574
### `Optional` voice
575575
576576
• **voice**? : _string_ (Default: **"demo-male"**)
577577
578-
_Defined in [src/SpokestackTray.tsx:184](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36/src/SpokestackTray.tsx#L184)_
578+
_Defined in [src/SpokestackTray.tsx:184](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a/src/SpokestackTray.tsx#L184)_
579579
580580
A key for a voice in Spokestack ASR, passed to Spokestack.synthesize
581581
582582
### wakewordModelUrls
583583
584584
• **wakewordModelUrls**: _object_
585585
586-
_Defined in [src/SpokestackTray.tsx:84](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36/src/SpokestackTray.tsx#L84)_
586+
_Defined in [src/SpokestackTray.tsx:84](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a/src/SpokestackTray.tsx#L84)_
587587
588588
The URLs of your wakeword model files.
589589
These models will be automatically downloaded
@@ -685,7 +685,7 @@ spokestackTray.current.say('Here is something for Spokestack to say')
685685
686686
▸ **open**(): _void_
687687
688-
_Defined in [src/SpokestackTray.tsx:579](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36/src/SpokestackTray.tsx#L579)_
688+
_Defined in [src/SpokestackTray.tsx:579](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a/src/SpokestackTray.tsx#L579)_
689689
690690
Open the tray, greet (if applicable), and listen
691691
@@ -697,7 +697,7 @@ Open the tray, greet (if applicable), and listen
697697
698698
▸ **close**(): _void_
699699
700-
_Defined in [src/SpokestackTray.tsx:590](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36/src/SpokestackTray.tsx#L590)_
700+
_Defined in [src/SpokestackTray.tsx:590](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a/src/SpokestackTray.tsx#L590)_
701701
702702
Close the tray, stop listening, and restart wakeword
703703
@@ -709,7 +709,7 @@ Close the tray, stop listening, and restart wakeword
709709
710710
▸ **say**(`input`: string): _Promise‹void›_
711711
712-
_Defined in [src/SpokestackTray.tsx:602](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36/src/SpokestackTray.tsx#L602)_
712+
_Defined in [src/SpokestackTray.tsx:602](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a/src/SpokestackTray.tsx#L602)_
713713
714714
Passes the input to Spokestack.synthesize(),
715715
plays the audio, and adds a speech bubble.
@@ -728,7 +728,7 @@ plays the audio, and adds a speech bubble.
728728
729729
▸ **addBubble**(`bubble`: Bubble): _void_
730730
731-
_Defined in [src/SpokestackTray.tsx:640](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36/src/SpokestackTray.tsx#L640)_
731+
_Defined in [src/SpokestackTray.tsx:640](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a/src/SpokestackTray.tsx#L640)_
732732
733733
Add a bubble (system or user)
734734
to the chat interface
@@ -753,7 +753,7 @@ to the chat interface
753753
754754
▸ **toggleSilent**(): _Promise‹boolean›_
755755
756-
_Defined in [src/SpokestackTray.tsx:652](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36/src/SpokestackTray.tsx#L652)_
756+
_Defined in [src/SpokestackTray.tsx:652](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a/src/SpokestackTray.tsx#L652)_
757757
758758
Toggle silent mode
759759
@@ -765,7 +765,7 @@ Toggle silent mode
765765
766766
▸ **isSilent**(): _boolean_
767767
768-
_Defined in [src/SpokestackTray.tsx:664](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36/src/SpokestackTray.tsx#L664)_
768+
_Defined in [src/SpokestackTray.tsx:664](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a/src/SpokestackTray.tsx#L664)_
769769
770770
Returns whether the tray is in silent mode
771771

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.2",
3+
"version": "0.2.3",
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)