@siposdani87/expo-rich-text-editor

This rich text editor written in TypeScript and use React Hooks structure. This component use the HTML ContentEditable div feature and React communicate and send data to native JavaScript via WebView. It has base editing options.

Getting Started

Installing

npm install @siposdani87/expo-rich-text-editor

Basic Usage

Check example directory for more samples and options.

import { MaterialIcons } from '@expo/vector-icons';
import { RichTextEditor, RichTextViewer, ActionMap, ActionKey } from '@siposdani87/expo-rich-text-editor';

const htmlStr = '<p><i><u>Underline italic text</u></i> <b>bold word</b> normal words</p>';

export const RichTextComponents = () => {
    const [value, setValue] = useState<string>('');

    const getColor = (selected: boolean): string => {
      return selected ? 'red' : 'black';
    };

    const getActionMap = (): ActionMap => {
        return {
            [ActionKey.bold]: ({ selected }) => (
                <MaterialIcons
                    name="format-bold"
                    size={14}
                    color={getColor(selected)}
                />
            ),
        };
    };

    const onValueChange = (v: string): void => {
        console.log('onValueChange', v);
        setValue(v);
    };

    return (
        <>
            <RichTextEditor
                minHeight={150}
                value={value}
                selectionColor="green"
                actionMap={getActionMap()}
                onValueChange={onValueChange}
                linkStyle={styles.link}
                textStyle={styles.text}
                containerStyle={styles.editor}
                toolbarStyle={styles.toolbar}
            />
            <RichTextViewer
                value={htmlStr}
                linkStyle={styles.link}
                textStyle={styles.text}
                containerStyle={styles.viewer}
            />
        </>
    );
};

const styles = StyleSheet.create({
    text: {
        // fontFamily: 'Inter_500Medium',
        fontSize: 18,
    },
    link: {
        color: 'green',
    },
    viewer: {
        borderColor: 'green',
        borderWidth: 1,
        padding: 5,
    },
    editor: {
        borderColor: 'blue',
        borderWidth: 1,
        padding: 5,
    },
    toolbar: {
        borderColor: 'red',
        borderWidth: 1,
    },
});

Props

RichTextEditor

| Prop | Type | Description | | --------------- | ----------------------- | ----------- | | value * | string | HTML string with standard tags e.g.: p, b, strong, i, em, u, a, br | | onValueChange * | (value: string) => void | Call this function on value changed | | onFocus | () => void | Call this function on component focus | | onBlur | () => void | Call this function on component blur | | onClickLink | (href: string) => void | Call this function on link clicked | | selectionColor | string | Color of text selection | | actionMap | ActionMap | Action config for toolbar component | | minHeight | number | Min height of container | | textStyle | StyleProp | Style of base text | | linkStyle | StyleProp | Style of link (a tag) | | containerStyle | StyleProp | Style of content container | | toolbarStyle | StyleProp | Style of toolbar container | | disabled | boolean | Disable editing on component | | autoFocus | boolean | Auto focus on component | | debug | boolean | Print debug information to console |

RichTextViewer

| Prop | Type | Description | | --------------- | ----------------------- | ----------- | | value * | string | HTML string with standard tags eg.: p, b, strong, i, em, u, a, ul, ol, li, br | | onClickLink | (href: string) => void | Call this function on link clicked | | textStyle | StyleProp | Style of base text | | linkStyle | StyleProp | Style of link (a tag) | | containerStyle | StyleProp | Style of content container | | debug | boolean | Print debug information to console |

Preview

Bugs or Requests

If you encounter any problems feel free to open an issue. If you feel the library is missing a feature, please raise a ticket. Pull request are also welcome.

Developer

Dániel Sipos

Sponsors

This project is generously supported by TrophyMap, I18Nature, and several other amazing organizations.