@types/react-twemoji

Installation

npm install --save @types/react-twemoji

Summary

This package contains type definitions for react-twemoji (https://github.com/zxmys/react-twemoji).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-twemoji.

index.d.ts

import * as React from "react";

export interface TwemojiProps {
    children?: React.ReactNode;

    /**
     * When it is true, Twemoji will not render a wrapping element (with tag)
     * to contain its children. Note that since twemoji.parse needs a DOM element
     * reference, any direct pure text child of Twemoji is not parsed when
     * noWrapper is true. E.g. foo in
     * <Twemoji noWrapper={true}>foo<p>bar</p></Twemoji> is not parsed.
     */
    noWrapper?: boolean;

    /**
     * twemoji.parse options.
     */
    options?: object;

    /**
     * The tag of the wrapping element. This option is ignored when noWrapper is
     * true.
     */
    tag?: string;
}

/**
 * A simple React wrapper for Twemoji. It calls twemoji.parse() to convert emoji
 * characters to Twemoji images.
 */
export default class Twemoji extends React.Component<TwemojiProps> {}

Additional Details

• Last updated: Tue, 07 Nov 2023 09:09:39 GMT
• Dependencies: @types/react

Credits

These definitions were written by smallpence.