Embed Bluesky comments on your website easily.
To use this library in a React project, first install the library:
npm install bluesky-commentsThen import it (and the CSS) in your React app/page/component:
import 'bluesky-comments/bluesky-comments.css'
import { BlueskyComments } from 'bluesky-comments';And use it in any React component like this:
function App() {
return (
<>
<div>Comments Will Display Below</div>
<BlueskyComments author="you.bsky.social" />
</>
)
}See the Usage section below for details on the options and API.
To add a comments section to any website, follow these steps
Add something like this to your site:
<div id="bluesky-comments"></div>You can use whatever id you want, but it has to match the container id used in the getElementById call
in the usage step.
Add the default styles the page <head> somewhere in a base template:
<link rel="stylesheet" href="https://unpkg.com/bluesky-comments@<VERSION>/dist/bluesky-comments.css">Add the following importmap to your page anywhere before you use the library:
<script type="importmap">
{
"imports": {
"react": "https://esm.sh/react@18",
"react-dom/client": "https://esm.sh/react-dom@18/client"
}
}
</script>
<script type="module">
import { createElement } from 'react';
import { createRoot } from 'react-dom/client';
import { BlueskyComments } from 'https://unpkg.com/bluesky-comments@<VERSION>/dist/bluesky-comments.es.js';
const author = 'you.bsky.social';
const container = document.getElementById('bluesky-comments');
const root = createRoot(container);
root.render(
createElement(BlueskyComments, {
"author": author,
})
);
</script>See the Usage section below for details on the options and API.
Examples in this section use the React JSX syntax. If you're installing on a project that doens't
use JSX or any build tooling (i.e. a regular website), you can instead use the createElement
function and pass the react options in.
For example, the following two examples are equivalent:
React JSX:
<BlueskyComments
author="you.bsky.social"
uri="https://bsky.app/profile/coryzue.com/post/3lbrko5zsgk24"
/>Equivalent without JSX:
root.render(
createElement(BlueskyComments, {
author: "you.bsky.social",
uri: "https://bsky.app/profile/coryzue.com/post/3lbrko5zsgk24",
})
);Note: this functionality is dependent on a flakey API and is not very reliable. More information here.
<BlueskyComments author="you.bsky.social" />If you use this mode, the comments section will use the most popular post by that author that links to the current page.
<BlueskyComments uri="https://bsky.app/profile/coryzue.com/post/3lbrko5zsgk24" />If you use this mode, the comments section will use the exact post you specify. This usually means you have to add the comments section only after you've linked to the article.
You can pass in a onEmpty callback to handle the case where there are no comments rendered
(for example, if no post matching the URL is found or there aren't any comments on it yet):
<BlueskyComments
uri="https://bsky.app/profile/coryzue.com/post/3lbrko5zsgk24"
author="you.bsky.social"
onEmpty={
(details) => {
console.error('Failed to load comments:', details);
document.getElementById('bluesky-comments').innerHTML =
'No comments on this post yet. Details: ' + details.message;
}
}
});You can pass in an array of filters to the commentFilters option. These are functions that take a comment and return a boolean. If any of the filters return true, the comment will not be shown.
A few default filters utilities are provided:
BlueskyFilters.NoPins: Hide comments that are just "📌"BlueskyFilters.NoLikes: Hide comments with no likes
You can also use the following utilities to create your own filters:
BlueskyFilters.MinLikeCountFilter: Hide comments with less than a given number of likesBlueskyFilters.MinCharacterCountFilter: Hide comments with less than a given number of charactersBluesky 8D66 Filters.TextContainsFilter: Hide comments that contain specific text (case insensitive)BlueskyFilters.ExactMatchFilter: Hide comments that match text exactly (case insensitive)
Pass filters using the commentFilters option:
import {BlueskyComments, BlueskyFilters} from 'bluesky-comments';
<BlueskyComments
// other options here
commentFilters={[
BlueskyFilters.NoPins, // Hide pinned comments
BlueskyFilters.MinCharacterCountFilter(10), // Hide comments with less than 10 characters
]}
/>You can also write your own filters, by returning true for comments you want to hide:
const NoTwitterLinksFilter = (comment) => {
return (comment.post.record.text.includes('https://x.com/') || comment.post.record.text.includes('https://twitter.com/'));
}
<BlueskyComments
// other options here
commentFilters={[
NoTwitterLinksFilter,
]
/>If you'd like to include links to deer.social in addition to BlueSky,
you can pass the enableDeer parameter when initializing the library:
<BlueskyComments
// other options
enableDeer=enableDeer={true}
/>To develop on this package, you can run:
npm install
npm run dev
This will set up a local development server with a simple page showing comments, and watch for changes.
You can also run npm run build (build once) or npm run watch (watch for changes)
to copy the built files to the dist directory.
From there you can reference the files in your own projects.