Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/danktuary/react-discord-message
React components to easily build and display fake Discord messages on your webpages.
https://github.com/danktuary/react-discord-message
discord react react-components
Last synced: about 2 months ago
JSON representation
React components to easily build and display fake Discord messages on your webpages.
- Host: GitHub
- URL: https://github.com/danktuary/react-discord-message
- Owner: Danktuary
- License: mit
- Created: 2019-03-18T00:08:25.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-10T16:58:17.000Z (about 2 years ago)
- Last Synced: 2024-09-23T12:17:38.833Z (3 months ago)
- Topics: discord, react, react-components
- Language: JavaScript
- Homepage: https://react-discord-message.netlify.app/
- Size: 1.7 MB
- Stars: 34
- Watchers: 2
- Forks: 6
- Open Issues: 30
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# React Discord Message
React components to easily build and display fake Discord messages on your webpages.
If you use Vue in your project, you should use [vue-discord-message](https://vue-discord-message.netlify.com/).
If you want to use web components instead, use [wc-discord-message](https://github.com/Danktuary/wc-discord-message)!
```sh
yarn add @danktuary/react-discord-message
# or npm install @danktuary/react-discord-message
# browser build also available: https://unpkg.com/@danktuary/react-discord-message
```
```jsx
import React from 'react';
import { DiscordMention, DiscordMessage, DiscordMessages } from '@danktuary/react-discord-message';
export default function App() {
return (
Hey guys, I'm new here! Glad to be able to join you all!
Hi, I'm new here too!
Hey, and Dawn. Welcome to our server!
Hello everyone! How's it going?
Thank you Sanctuary!
I'm doing well, Twelve. What about yourself?
!8ball How am I doing today?
Yes.
)
}
```
## Features
* Design modeled after [Discord](https://discord.com/) itself
* Comfy and compact mode support
* Dark and light themes support
* Set the message author's username, avatar (use defaults or provide your own), role color, and "bot" tag status
* Display fake user, role, and channel mentions
* Complete embed support
* Simple syntax!
## Installation
### Package managers
If you're using a package manager, you can install it like normal.
```bash
yarn add @danktuary/react-discord-message
# or npm install @danktuary/react-discord-message
```
Import it and then use the components in your JSX.
```jsx
import React from 'react'
import { DiscordMessage, DiscordMessages } from '@danktuary/react-discord-message'
export default function App() {
return (
Hey guys, I'm new here! Glad to be able to join you all!
Hi, I'm new here too!
)
}
```
### Browser build
If you want to use the browser build, you can pull it in via unpkg, along with the other necessary files.
```html
const { DiscordMessage, DiscordMessages } = ReactDiscordMessage
ReactDOM.render((
<DiscordMessages>
<DiscordMessage>
Hey guys, I'm new here! Glad to be able to join you all!
</DiscordMessage>
<DiscordMessage author="Dawn" avatar="red">
Hi, I'm new here too!
</DiscordMessage>
<DiscordMessages>
), document.getElementById('root'))
```
Do note that using a package manager is recommended.
## Usage
The syntax is kept fairly simple. Here's a basic example of a regular conversation:
```jsx
Hey guys, I'm new here! Glad to be able to join you all!
Hi, I'm new here too!
Hey, and Dawn. Welcome to our server!
```
### Context options
After installation, you can use the `` component to configure the plugin to your liking through the following settings.
```jsx
import React from 'react'
import {
DiscordDefaultOptions
DiscordMessage,
DiscordMessages,
DiscordOptionsContext,
} from '@danktuary/react-discord-message'
// Extend the default options in order to provide your own
const discordOptions = {
...DiscordDefaultOptions,
// ...
}
export default function App() {
return (
...
...
)
}
```
#### Default font
By default, this package uses the Google Fonts CDN to pull in the Roboto font. This isn't the same font Discord uses, so if you want to provide your own, you can override the CSS.
```css
/* index.css */
.discord-messages {
font-family: 'Your Font', sans-serif;
}
```
#### Avatar shortcuts
The current avatar shortcut strings available are "blue" (default), "gray", "green", "orange", and "red". These shortcuts map to the following image links:
```json
{
"blue": "https://cdn.discordapp.com/attachments/654503812593090602/665721745466195978/blue.png",
"gray": "https://cdn.discordapp.com/attachments/654503812593090602/665721746569166849/gray.png",
"green": "https://cdn.discordapp.com/attachments/654503812593090602/665721748431306753/green.png",
"orange": "https://cdn.discordapp.com/attachments/654503812593090602/665721750201434138/orange.png",
"red": "https://cdn.discordapp.com/attachments/654503812593090602/665721752277483540/red.png"
}
```
If you want to add to or override the shortcuts, you can set them via the `avatars` property.
```js
const discordOptions = {
...DiscordDefaultOptions,
avatars: {
...DiscordDefaultOptions.avatars,
'default': DiscordDefaultOptions.avatars.green,
jojo: 'https://i.imgur.com/BOlehTj.jpg',
},
}
```
#### Profile shortcuts
Sometimes you'll want to use the same message data across multiple messages. You can do so by providing an object of profiles.
```js
const discordOptions = {
...DiscordDefaultOptions,
profiles: {
sanc: {
author: 'Sanctuary',
avatar: 'https://i.imgur.com/0TeacfY.png',
},
rinon: {
author: 'Rinon',
avatar: 'https://i.imgur.com/axQ9wJl.png',
bot: true,
roleColor: '#ee82ee',
},
},
}
```
And then in your JSX:
```jsx
export default function App() {
return (
Welcome to our server, !
Hey, glad to be here!
)
}
```
### Components notes
Below are notes for a few certain components. If you want to see what props each component has, check the `propTypes` property within in the respective components inside the [`/src/components/`](https://github.com/Danktuary/react-discord-message/blob/master/src/components/) folder.
#### DiscordMessages component
This is a wrapper for any child `` component. It must be used in order for messages to display properly.
#### DiscordMention component
If the default slot is left empty, the mention will be rendered as `'User'`, `'Role'`, or `'channel`', depending on the `type` prop given.
#### DiscordEmbed component
An embed that can be attached to the end of your messages. The default slot is used for the embed's description. The `footer` slot is used for the footer text.
To ensure the embed gets displayed correctly inside your message, be sure to give it the proper `slot` attribute.
```jsx
Hi, I'm part of the normal message content.
Hi, I'm part of the embed message content.
```
#### EmbedFields component
A wrapper for any child `` components. Must be used in order for fields to display properly. To ensure the embed fields gets displayed correctly inside your embed, be sure to give it the proper `slot` attribute.
```jsx
Hi, I'm part of the embed message content.
{/* Embed fields go here */}
```
#### EmbedField component
At least 2 consecutive fields need to be marked as inline in order for them to actually display next to each other. The maximum amount of inline fields is 3.
```jsx
Hi, I'm part of the embed message content.
Field content.
Field content.
```