How to use Stencil's `EventEmitter` inside React JSX?

Question

I created an Input web component with Stencil:

...
export class Input {
    @Prop({ mutable: true }) value: string;
    @Event() changed: EventEmitter<KeyboardEvent>;

    private handleChange (e) {
        this.value = e.target?.value;
        this.changed.emit(e);
    }

    render() {
        return (
            <div class="inputContainer">
                <input  
                    type="text"
                    value={this.value}
                    onInput={this.handleChange}
                />
            </div>
        )
    }
}

Then after trying to use it inside React jsx file, onChanged does not call console.log

...

function App() {
  return (
    <div className="App">
      // does not call console.log
      <ui-input onChanged={(e) => console.log(e)}/>
    </div>
  );
}

As I've read so far it's because React uses the synthetic event instead of Dom events.

Is there any way to use Dom events within JSX element?

score 5 · Accepted Answer · answered Feb 20 '20 at 08:08

You would have to manually attach the event listener using the DOM API, for example:

document.querySelector('ui-input').addEventListener('changed', console.log)

(You can also use the ref prop to get a reference to the DOM element which is probably more robust.)

Relevant docs section: https://stenciljs.com/docs/react#properties-and-events
Relevant Github issue: https://github.com/facebook/react/issues/7901

You have another option though, and that's to use the stencil-ds-plugins, specifically the @stencil/react-output-target npm package. When you build your component/library, the output target will generate all the necessary bindings (props, custom events, etc.) for you, and you'll be able to use your component as a react component. The only available docs so far ar in the readme: https://github.com/ionic-team/stencil-ds-plugins#react.

score 0 · Answer 2 · answered Jul 15 '22 at 02:18

You need to bind the current context to the method.

Check Event emit error for more explanation

...
export class Input {
    constructor() {
       this.handleChange = this.handleChange.bind(this);
    }

    @Prop({ mutable: true }) value: string;
    @Event() changed: EventEmitter<KeyboardEvent>;

    private handleChange (e) {
        this.value = e.target?.value;
        this.changed.emit(e);
    }

    render() {
        return (
            <div class="inputContainer">
                <input  
                    type="text"
                    value={this.value}
                    onInput={this.handleChange}
                />
            </div>
        )
    }
}

How to use Stencil's `EventEmitter` inside React JSX?

2 Answers2