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

Commit 45f16ba

Browse files
committed
chore: release 0.2.0
1 parent 59ce3e9 commit 45f16ba

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/7a2617f/src/Spokestack.ts#L591)_
221+
_Defined in [src/Spokestack.ts:591](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9/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/7a2617f/src/Spokestack.ts#L611)_
242+
_Defined in [src/Spokestack.ts:611](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9/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/7a2617f/src/Spokestack.ts#L475)_
262+
_Defined in [src/Spokestack.ts:475](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9/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/7a2617f/src/SpokestackTray.tsx#L90)_
284+
_Defined in [src/SpokestackTray.tsx:90](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9/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/7a2617f/src/SpokestackTray.tsx#L55)_
292+
_Defined in [src/SpokestackTray.tsx:55](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9/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/7a2617f/src/SpokestackTray.tsx#L62)_
303+
_Defined in [src/SpokestackTray.tsx:62](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9/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/7a2617f/src/SpokestackTray.tsx#L92)_
314+
_Defined in [src/SpokestackTray.tsx:92](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9/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/7a2617f/src/SpokestackTray.tsx#L94)_
322+
_Defined in [src/SpokestackTray.tsx:94](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9/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/7a2617f/src/SpokestackTray.tsx#L96)_
330+
_Defined in [src/SpokestackTray.tsx:96](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9/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/7a2617f/src/SpokestackTray.tsx#L101)_
338+
_Defined in [src/SpokestackTray.tsx:101](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9/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/7a2617f/src/SpokestackTray.tsx#L106)_
357+
_Defined in [src/SpokestackTray.tsx:106](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9/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/7a2617f/src/SpokestackTray.tsx#L111)_
366+
_Defined in [src/SpokestackTray.tsx:111](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9/src/SpokestackTray.tsx#L111)_
367367
368368
Font to use for "LISTENING...", "LOADING...",
369369
and chat bubble text.
@@ -372,15 +372,15 @@ and chat bubble text.
372372
373373
• **gradientColors**? : _string[]_
374374
375-
_Defined in [src/SpokestackTray.tsx:115](https://github.com/spokestack/react-native-spokestack-tray/blob/7a2617f/src/SpokestackTray.tsx#L115)_
375+
_Defined in [src/SpokestackTray.tsx:115](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9/src/SpokestackTray.tsx#L115)_
376376
377377
Colors for the linear gradient shown when listening
378378
379379
### `Optional` greet
380380
381381
• **greet**? : _boolean_ (Default: **false**)
382382
383-
_Defined in [src/SpokestackTray.tsx:121](https://github.com/spokestack/react-native-spokestack-tray/blob/7a2617f/src/SpokestackTray.tsx#L121)_
383+
_Defined in [src/SpokestackTray.tsx:121](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9/src/SpokestackTray.tsx#L121)_
384384
385385
Whether to greet the user with a welcome message
386386
when the tray opens.
@@ -390,7 +390,7 @@ Default: false
390390
391391
• **handleIntent**: _function_
392392
393-
_Defined in [src/SpokestackTray.tsx:72](https://github.com/spokestack/react-native-spokestack-tray/blob/7a2617f/src/SpokestackTray.tsx#L72)_
393+
_Defined in [src/SpokestackTray.tsx:72](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9/src/SpokestackTray.tsx#L72)_
394394
395395
This function takes an intent from the NLU
396396
and returns an object with a unique conversation
@@ -416,7 +416,7 @@ if sound has been turned off.
416416
417417
• **haptic**? : _boolean_ (Default: **true**)
418418
419-
_Defined in [src/SpokestackTray.tsx:126](https://github.com/spokestack/react-native-spokestack-tray/blob/7a2617f/src/SpokestackTray.tsx#L126)_
419+
_Defined in [src/SpokestackTray.tsx:126](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9/src/SpokestackTray.tsx#L126)_
420420
421421
Set this to false to disable the haptic
422422
that gets played whenever the tray starts listening.
@@ -425,15 +425,15 @@ that gets played whenever the tray starts listening.
425425
426426
• **minHeight**? : _number_ (Default: **170**)
427427
428-
_Defined in [src/SpokestackTray.tsx:128](https://github.com/spokestack/react-native-spokestack-tray/blob/7a2617f/src/SpokestackTray.tsx#L128)_
428+
_Defined in [src/SpokestackTray.tsx:128](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9/src/SpokestackTray.tsx#L128)_
429429
430430
Minimum height for the tray
431431
432432
### `Optional` nluModelUrls
433433
434434
• **nluModelUrls**? : _object_
435435
436-
_Defined in [src/SpokestackTray.tsx:136](https://github.com/spokestack/react-native-spokestack-tray/blob/7a2617f/src/SpokestackTray.tsx#L136)_
436+
_Defined in [src/SpokestackTray.tsx:136](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9/src/SpokestackTray.tsx#L136)_
437437
438438
The URLs of your NLU model files.
439439
These models will be automatically downloaded
@@ -453,7 +453,7 @@ See https://spokestack.io/docs/Concepts/nlu
453453
454454
• **onClose**? : _function_
455455
456-
_Defined in [src/SpokestackTray.tsx:144](https://github.com/spokestack/react-native-spokestack-tray/blob/7a2617f/src/SpokestackTray.tsx#L144)_
456+
_Defined in [src/SpokestackTray.tsx:144](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9/src/SpokestackTray.tsx#L144)_
457457
458458
Called whenever the tray has closed
459459
@@ -465,7 +465,7 @@ Called whenever the tray has closed
465465
466466
• **onError**? : _function_
467467
468-
_Defined in [src/SpokestackTray.tsx:146](https://github.com/spokestack/react-native-spokestack-tray/blob/7a2617f/src/SpokestackTray.tsx#L146)_
468+
_Defined in [src/SpokestackTray.tsx:146](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9/src/SpokestackTray.tsx#L146)_
469469
470470
Called whenever there's an error from Spokestack
471471

@@ -483,7 +483,7 @@ Called whenever there's an error from Spokestack
483483

484484
**onOpen**? : _function_
485485

486-
_Defined in [src/SpokestackTray.tsx:148](https://github.com/spokestack/react-native-spokestack-tray/blob/7a2617f/src/SpokestackTray.tsx#L148)_
486+
_Defined in [src/SpokestackTray.tsx:148](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9/src/SpokestackTray.tsx#L148)_
487487

488488
Called whenever the tray has opened
489489

@@ -495,15 +495,15 @@ Called whenever the tray has opened
495495

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

498-
_Defined in [src/SpokestackTray.tsx:152](https://github.com/spokestack/react-native-spokestack-tray/blob/7a2617f/src/SpokestackTray.tsx#L152)_
498+
_Defined in [src/SpokestackTray.tsx:152](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9/src/SpokestackTray.tsx#L152)_
499499

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

502502
### `Optional` primaryColor
503503

504504
**primaryColor**? : _string_ (Default: **"**)
505505
506-
_Defined in [src/SpokestackTray.tsx:157](https://github.com/spokestack/react-native-spokestack-tray/blob/7a2617f/src/SpokestackTray.tsx#L157)_
506+
_Defined in [src/SpokestackTray.tsx:157](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9/src/SpokestackTray.tsx#L157)_
507507
508508
This color is used to theme the tray
509509
and is used in the mic button and speech bubbles.
@@ -512,7 +512,7 @@ and is used in the mic button and speech bubbles.
512512
513513
• **refreshModels**? : _boolean_
514514
515-
_Defined in [src/SpokestackTray.tsx:164](https://github.com/spokestack/react-native-spokestack-tray/blob/7a2617f/src/SpokestackTray.tsx#L164)_
515+
_Defined in [src/SpokestackTray.tsx:164](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9/src/SpokestackTray.tsx#L164)_
516516
517517
Use this sparingly to refresh the
518518
wakeword and NLU models on device
@@ -523,7 +523,7 @@ wakeword and NLU models on device
523523
524524
• **sayGreeting**? : _boolean_ (Default: **true**)
525525
526-
_Defined in [src/SpokestackTray.tsx:171](https://github.com/spokestack/react-native-spokestack-tray/blob/7a2617f/src/SpokestackTray.tsx#L171)_
526+
_Defined in [src/SpokestackTray.tsx:171](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9/src/SpokestackTray.tsx#L171)_
527527
528528
Whether to speak the greeting or only display
529529
a chat bubble with the greet message,
@@ -534,55 +534,55 @@ Default: true
534534
535535
• **soundOffImage**? : _React.ReactNode_
536536
537-
_Defined in [src/SpokestackTray.tsx:175](https://github.com/spokestack/react-native-spokestack-tray/blob/7a2617f/src/SpokestackTray.tsx#L175)_
537+
_Defined in [src/SpokestackTray.tsx:175](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9/src/SpokestackTray.tsx#L175)_
538538
539539
Replace the sound off image by passing an <Image />
540540
541541
### `Optional` soundOnImage
542542
543543
• **soundOnImage**? : _React.ReactNode_
544544
545-
_Defined in [src/SpokestackTray.tsx:173](https://github.com/spokestack/react-native-spokestack-tray/blob/7a2617f/src/SpokestackTray.tsx#L173)_
545+
_Defined in [src/SpokestackTray.tsx:173](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9/src/SpokestackTray.tsx#L173)_
546546
547547
Replace the sound on image by passing an <Image />
548548
549549
### `Optional` startHeight
550550
551551
• **startHeight**? : _number_ (Default: **220**)
552552
553-
_Defined in [src/SpokestackTray.tsx:177](https://github.com/spokestack/react-native-spokestack-tray/blob/7a2617f/src/SpokestackTray.tsx#L177)_
553+
_Defined in [src/SpokestackTray.tsx:177](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9/src/SpokestackTray.tsx#L177)_
554554
555555
Starting height for tray
556556
557557
### `Optional` style
558558
559559
• **style**? : _Animated.WithAnimatedValue‹StyleProp‹ViewStyle››_
560560
561-
_Defined in [src/SpokestackTray.tsx:179](https://github.com/spokestack/react-native-spokestack-tray/blob/7a2617f/src/SpokestackTray.tsx#L179)_
561+
_Defined in [src/SpokestackTray.tsx:179](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9/src/SpokestackTray.tsx#L179)_
562562
563563
This style prop is passed to the tray's container
564564
565565
### `Optional` ttsFormat
566566
567567
• **ttsFormat**? : _TTSFormat_ (Default: **TTSFormat.TEXT**)
568568
569-
_Defined in [src/SpokestackTray.tsx:181](https://github.com/spokestack/react-native-spokestack-tray/blob/7a2617f/src/SpokestackTray.tsx#L181)_
569+
_Defined in [src/SpokestackTray.tsx:181](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9/src/SpokestackTray.tsx#L181)_
570570
571571
The format for the text passed to Spokestack.synthesize
572572
573573
### `Optional` voice
574574
575575
• **voice**? : _string_ (Default: **"demo-male"**)
576576
577-
_Defined in [src/SpokestackTray.tsx:183](https://github.com/spokestack/react-native-spokestack-tray/blob/7a2617f/src/SpokestackTray.tsx#L183)_
577+
_Defined in [src/SpokestackTray.tsx:183](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9/src/SpokestackTray.tsx#L183)_
578578
579579
A key for a voice in Spokestack ASR, passed to Spokestack.synthesize
580580
581581
### wakewordModelUrls
582582
583583
• **wakewordModelUrls**: _object_
584584
585-
_Defined in [src/SpokestackTray.tsx:84](https://github.com/spokestack/react-native-spokestack-tray/blob/7a2617f/src/SpokestackTray.tsx#L84)_
585+
_Defined in [src/SpokestackTray.tsx:84](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9/src/SpokestackTray.tsx#L84)_
586586
587587
The URLs of your wakeword model files.
588588
These models will be automatically downloaded
@@ -684,7 +684,7 @@ spokestackTray.current.say('Here is something for Spokestack to say')
684684
685685
▸ **open**(): _void_
686686
687-
_Defined in [src/SpokestackTray.tsx:578](https://github.com/spokestack/react-native-spokestack-tray/blob/7a2617f/src/SpokestackTray.tsx#L578)_
687+
_Defined in [src/SpokestackTray.tsx:578](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9/src/SpokestackTray.tsx#L578)_
688688
689689
Open the tray, greet (if applicable), and listen
690690
@@ -696,7 +696,7 @@ Open the tray, greet (if applicable), and listen
696696
697697
▸ **close**(): _void_
698698
699-
_Defined in [src/SpokestackTray.tsx:585](https://github.com/spokestack/react-native-spokestack-tray/blob/7a2617f/src/SpokestackTray.tsx#L585)_
699+
_Defined in [src/SpokestackTray.tsx:585](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9/src/SpokestackTray.tsx#L585)_
700700
701701
Close the tray, stop listening, and restart wakeword
702702
@@ -708,7 +708,7 @@ Close the tray, stop listening, and restart wakeword
708708
709709
▸ **say**(`input`: string): _Promise‹void›_
710710
711-
_Defined in [src/SpokestackTray.tsx:593](https://github.com/spokestack/react-native-spokestack-tray/blob/7a2617f/src/SpokestackTray.tsx#L593)_
711+
_Defined in [src/SpokestackTray.tsx:593](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9/src/SpokestackTray.tsx#L593)_
712712
713713
Passes the input to Spokestack.synthesize(),
714714
plays the audio, and adds a speech bubble.
@@ -727,7 +727,7 @@ plays the audio, and adds a speech bubble.
727727
728728
▸ **addBubble**(`bubble`: Bubble): _void_
729729
730-
_Defined in [src/SpokestackTray.tsx:631](https://github.com/spokestack/react-native-spokestack-tray/blob/7a2617f/src/SpokestackTray.tsx#L631)_
730+
_Defined in [src/SpokestackTray.tsx:631](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9/src/SpokestackTray.tsx#L631)_
731731
732732
Add a bubble (system or user)
733733
to the chat interface
@@ -752,7 +752,7 @@ to the chat interface
752752
753753
▸ **toggleSilent**(): _Promise‹boolean›_
754754
755-
_Defined in [src/SpokestackTray.tsx:643](https://github.com/spokestack/react-native-spokestack-tray/blob/7a2617f/src/SpokestackTray.tsx#L643)_
755+
_Defined in [src/SpokestackTray.tsx:643](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9/src/SpokestackTray.tsx#L643)_
756756
757757
Toggle silent mode
758758
@@ -764,7 +764,7 @@ Toggle silent mode
764764
765765
▸ **isSilent**(): _boolean_
766766
767-
_Defined in [src/SpokestackTray.tsx:655](https://github.com/spokestack/react-native-spokestack-tray/blob/7a2617f/src/SpokestackTray.tsx#L655)_
767+
_Defined in [src/SpokestackTray.tsx:655](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9/src/SpokestackTray.tsx#L655)_
768768
769769
Returns whether the tray is in silent mode
770770

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