social-textarea v0.0.30

social-textarea

A React "social" textarea that supports user mentions, emojis and url previews.

Works on mobile.

Built on top of react-mentions and emoji-mart (a virtualized fork).

Authors

• @juliendelort

Installation

  npm install social-textarea

Live Demo

See demo here (code).

Usage/Examples

Import the main component and the styles on your pabe

import { SocialTextArea } from 'social-textarea';
import 'social-textarea/dist/SocialTextArea.css';

Basic usage

 <SocialTextArea placeholder="Type ':' followed by a character to see emojis"/>

Emoji picker and link previews:

<SocialTextArea placeholder="Type ':' followed by a character to see emojis" >
    <SocialTextArea.EmojiPicker />
    <SocialTextArea.LinkPreview />
</SocialTextArea>

User mentions:

export default function App() {
  // This function can be async
  const handleSearchUsers = (name) => {
    // This can be an ajax call, as long as it returns an array of object {id, name, image}
    return ALL_USERS.filter(({ name }) => name.indexOf(name) >= 0);
  };
  return (
    <div className="App">
      <SocialTextArea 
        onSearchUsers={handleSearchUsers}
        placeholder="Type ':' for emojis, '@' for mentions"
       >
        <SocialTextArea.EmojiPicker />
        <SocialTextArea.LinkPreview />
      </SocialTextArea>
    </div>
  );
}

const ALL_USERS = [
  {
    id: "1",
    name: "Matthew Russell",
    image: "https://twitter.com/mrussell247"
  },
  {
    id: "2",
    name: "Julian Krispel-Samsel",
    image: "https://avatars2.githubusercontent.com/u/1188186?v=3&s=400"
  },
  {
    id: "3",
    name: "Jyoti Puri",
    image: "https://avatars0.githubusercontent.com/u/2182307?v=3&s=400"
  },
  {
    id: "4",
    name: "Max Stoiber",
    image: "https://avatars0.githubusercontent.com/u/7525670?s=200&v=4"
  },
  {
    id: "5",
    name: "Nik Graf",
    image: "https://avatars0.githubusercontent.com/u/223045?v=3&s=400"
  },
  {
    id: "6",
    name: "Pascal Brandt",
    image:
      "https://pbs.twimg.com/profile_images/688487813025640448/E6O6I011_400x400.png"
  }
];

Better link previews

It is possible to use a tool like link-preview-js to generate better link previews. For CORS reasons, link-preview-js has to be used in the backend, through an API call.

export default function App() {

  const handleFetchLinkPreview = React.useCallback(async (url) => {
    // Fetch data and return { siteName, title, description, images, favicons, url }
  }, []);


  return (
    <>
      <SocialTextArea onFetchLinkPreview={handleFetchLinkPreview}>
        <SocialTextArea.EmojiPicker />
        <SocialTextArea.LinkPreview />
      </SocialTextArea>
    </>
  );
}

Example backend handler using link-preview-js:

return await getLinkPreview(url, {
    headers: {
        "user-agent": "googlebot", // fetches with googlebot crawler user agent
    },
    timeout: 3000
});

Styling

Styles are imported from SocialTextArea.css and can be overriden. Example:

/* Changing the mention highlight color */
.social-text-area .social-text-area__mention {
  background: tomato;
}

/* Changing fontsize of user suggestion items */ 
.social-text-area .mentionInputRoot .mentionInputRoot__suggestions__item {
  font-size: 14px;
}

Controlled vs uncontrolled

Controlled

const [value, setValue] = React.useState();
return (
    <>
        <SocialTextArea value={value} onValueChange={(value)=>setValue(value)}>
            <SocialTextArea.EmojiPicker />
            <SocialTextArea.LinkPreview />
        </SocialTextArea>
    </>
);

Uncontrolled

<SocialTextArea onValueChange={(value)=>console.log(value)}>
    <SocialTextArea.EmojiPicker />
    <SocialTextArea.LinkPreview />
</SocialTextArea>
    

Props

All props are optional.

• value (object): For using the component in "controlled" mode. Fields:

  • rawValue (string): value containing all the internal delimiters.
  • plainText (string): plain text value

  • mentions (object): information about the highlighted user mentions

    Example of value object:

    {
        rawValue: "Hi [[1|Matthew Russell]], check this out #http://facebook.com# ",
        plainText: "Hi Matthew Russell, check this out http://facebook.com ",
        mentions: [
            {
                id: "1",
                display: "Matthew Russell",
                childIndex: 0,
                index: 3,
                plainTextIndex: 3
            }
        ]
    }

• defaultValue (object): Same as above, but for "uncontrolled" mode. The value to use when the component is initialized.

• onValueChange (function(value)): Called when the value in the component changes. The value object is passed as parameter.
• className (string): The component root class name.
• placeholder (string): Placeholder for the textarea
• onFetchLinkPreview (function(url)): Called when the previewed url changes. Can be used to retrieve additional information using a library like link-preview-js. See Better link previews.
• onSearchUsers (function(name)): Called to retrieved the user suggestions. If a user types "@Br" in the component, this function will be called with "br" as parameter. See User mentions.

Flag emojis font issue on windows

On windows, the flag emojis (for example :flag-ca:), are not displayed properly, whereas there is no issue on macos. More info about this issue here.

As a fix, the component uses the font "TwemojiMozilla" (included in the package here and on unpkg) but it needs to be added to the host page:

@font-face {
  font-family: 'TwemojiMozilla';
  unicode-range: U+1F1E6-1F1FF;
  src: url('https://unpkg.com/social-textarea@latest/dist/assets/twemoji-colrv0.ttf')
    format('truetype');
  font-weight: normal;
}