Embed Bluesky comments on your website easily.
There are a few ways to set up the library on your website.
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 value used in BlueskyComments.init
in the later steps.
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": "https://esm.sh/react-dom@18"
}
}
</script>
<script type="module">
import { BlueskyComments } from 'https://unpkg.com/[email protected]/dist/bluesky-comments.es.js';
document.addEventListener('DOMContentLoaded', function() {
const author = 'you.bsky.social';
if (author) {
BlueskyComments.init('bluesky-comments', {author});
}
});
</script>See the Usage section for details on the API.
Previous versions of this library recommended installing like this:
<script src="https://unpkg.com/react@18/umd/react.production.min.js"></script>
<script src="https://unpkg.com/react-dom@18/umd/react-dom.production.min.js"></script>
<script src="https://unpkg.com/bluesky-comments@<VERSION>/dist/bluesky-comments.umd.js"></script>And initializing the comments in a standard <script> tag. Both of these approaches work:
<script>
document.addEventListener('DOMContentLoaded', function() {
const uri = 'https://bsky.social/coryzue.com/posts/3jxgux';
if (uri) {
// New API
BlueskyComments.init('bluesky-comments', {uri});
// Legacy API (still supported but deprecated)
initBlueskyComments('bluesky-comments', {uri});
}
});
</script>This option is now deprecated with the introduction of ES modules and will be removed in a future version.
const author = 'you.bsky.social';
BlueskyComments.init('bluesky-comments', {author});If you use this mode, the comments section will use the most popular post by that author that links to the current page.
const uri = 'https://bsky.social/coryzue.com/posts/3jxgux';
BlueskyComments.init('bluesky-comments', {uri});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.init('bluesky-comments', {
uri,
author,
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:
BlueskyComments.Filters.NoPins: Hide comments that are just "📌"BlueskyComments.Filters.NoLikes: Hide comments with no likes
You can also use the following utilities to create your own filters:
BlueskyComments.Filters.MinLikeCountFilter: Hide comments with less than a given number of likesBlueskyComments.Filters.MinCharacterCountFilter: Hide comments with less than a given number of charactersBlueskyComments.Filters.TextContainsFilter: Hide comments that contain specific text (case insensitive)BlueskyComments.Filters.ExactMatchFilter: Hide comments that match text exactly (case insensitive)
Pass filters using the commentFilters option:
BlueskyComments.init('bluesky-comments', {
// other options here
commentFilters: [
BlueskyComments.Filters.NoPins, // Hide pinned comments
BlueskyComments.Filters.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.init('bluesky-comments', {
// other options here
commentFilters: [
NoTwitterLinksFilter,
]
});Install the package:
npm install bluesky-commentsThen you can use the library in your projects by importing the CSS and components:
import 'bluesky-comments/bluesky-comments.css'
import { CommentSection } from "bluesky-comments";And using them in a React component like this:
function App() {
return (
<>
<div>Comments Will Display Below</div>
<CommentSection
author="coryzue.com"
uri=""
onEmpty={() => <div>No comments yet</div>}
commentFilters={[]} />
</div>
</>
)
}I don't publish a lot of JavaScript packages, but I think this should work!
To develop on this package, you can run:
npm install
npm run watch
This will watch for changes and copy the built files to the dist directory.
From there you can reference the files in your own project and any updates you make
should show up instantly.
