You signed in with another tab or window.Reload to refresh your session.You signed out in another tab or window.Reload to refresh your session.You switched accounts on another tab or window.Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Oct 28, 2022. It is now read-only.
When bundling via webpack,dist/vue-next-rx.esm.js is used by default. It imports the minimal amount of Rx operators and ensures small bundle sizes.
To use in a browser environment, use the UMD builddist/vue-next-rx.js. When in a browser environment, the UMD build assumeswindow.rxjs to be already present, so make sure to includevue-next-rx.js after Vue.js and RxJS. It also installs itself automatically ifwindow.Vue is present.
Example:
<scriptsrc="https://unpkg.com/rxjs@^7/dist/bundles/rxjs.umd.min.js"></script><scriptsrc="https://unpkg.com/vue@next"></script><scriptsrc="../dist/vue-next-rx.js"></script><divid="app"><divclass="home"><buttonv-stream:click="click$">Click Me</button></div></div><script>const{ Subject, Observable, BehaviorSubject}=rxjs;const{ map, startWith, scan}=rxjs.operators;const{ ref, watch}=VueNextRx;// Use VueNextRxconstapp=Vue.createApp({domStreams:["click$"],subscriptions(){this.click$.pipe(map(()=>"Click Event")).subscribe(console.log);// On click will print "Click Event"},}).use(VueNextRx);app.mount("#app");</script>
Usage
Subscriptions
// Expose `Subject` with domStream, use them in subscriptions functionsexportdefaultdefineComponent({name:"Home",domStreams:["click$"],subscriptions(){return{count:this.click$.pipe(map(()=>1),startWith(0),scan((total,change)=>total+change)),};});
<div><buttonv-stream:click="click$">Click Me</button></div><div>{{count}}</div><!-- On click will show 0, 1 ,2 ,3... -->
Or
// Expose `Subject` with domStream, use them in subscriptions functionsexportdefaultdefineComponent({name:"Home",domStreams:["action$"],subscriptions(){this.action$.pipe(map(()=>"Click Event !")).subscribe(console.log);// On click will print "Click Event"},});
Tips
You can get the data by simply plucking it from the source stream:
import{ref}from"@nopr3d/vue-next-rx";// use ref like an Rx SubjectexportdefaultdefineComponent({name:"Home",components:{},setup(){constmsg=ref("Message exemple");setTimeout(()=>{msg.value="New message !";},2000);msg.subscribe((value)=>{console.log(value);// After 2s will print : New message !});return{ msg};},});
<!-- bind to it normally in templates --><!-- on change DOM is update too --><div>{{ msg }}</div>
Watch
import{ref,watch}from"@nopr3d/vue-next-rx";exportdefaultdefineComponent({name:"Home",components:{},setup(){constmsg=ref("Message exemple");watch(msg).subscribe((val)=>{console.log(val);// After 2s will print : New message !});setTimeout(()=>{msg.value="New message !";},2000);return{ msg};},});
<!-- bind to it normally in templates --><!-- on change DOM is update too --><div>{{ msg }}</div>
Other API Methods
$watchAsObservable(expOrFn, [options])
This is a prototype method added to instances. You can use it to create an observable from a Data. The emitted value is in the format of{ newValue, oldValue }:
<!-- bind to it normally in templates --><!-- on change DOM is update too --><div>{{ msg }}</div><!-- Will display : Old message, after 1 second display "New Message !" --><div>{{oldMsg}}</div><!-- wait for value and display "Old Message" after 1 second -->
$subscribeTo(observable, next, error, complete)
This is a prototype method added to instances. You can use it to subscribe to an observable, but let VueNextRx manage the dispose/unsubscribe.
This is a prototype method added to instances. Use it to create an observable from DOM events within the instances' element. This is similar toRx.Observable.fromEvent, but usable inside thesubscriptions function even before the DOM is actually rendered.
selector is for finding descendant nodes under the component root element, if you want to listen to events from root element itself, passnull as first argument.
Convert function calls to observable sequence which emits the call arguments.
This is a prototype method added to instances. Use it to create a shared hot observable from a function name. The function will be assigned as a vm method.
