🐘 Mastodon embed timeline (new v4)
Embed a mastodon feed timeline in your page, only with a CSS and JS file.
Demo running: https://codepen.io/ipuntoj/pen/MWppNGL
📋 Table of contents
Installation
Ready-to-use compiled and minified files to easily start.
- Download into your project the following files:
dist/mastodon-timeline.min.cssdist/mastodon-timeline.min.js
Now call the CSS and JS files in your HTML page using the <link> and <script> tags as follows in this example:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Mastodon embed timeline</title>
<!-- CSS -->
<link href="path/to/mastodon-timeline.min.css" rel="stylesheet" />
</head>
<body>
<!-- Your HTML content -->
<!-- JavaScript -->
<script src="path/to/mastodon-timeline.min.js"></script>
</body>
</html>
Usage
Initialize
The first step to get your timeline up is to add the following HTML structure in your page:
<div id="mt-container" class="mt-container">
<div class="mt-body" role="feed">
<div class="mt-loading-spinner"></div>
</div>
</div>
Then after that you can initialize the script by running:
const myTimeline = new MastodonTimeline();
By default it will show a timeline with 20 posts from the instance mastodon.social
ℹ️ If you are trying to initialize the script before mastodon-timeline.js is loaded, you will probably get such an error: "MastodonTimeline is not defined". To fix that initialize the script by running:
window.addEventListener("load", () => {
const myTimeline = new MastodonTimeline();
});
Local timeline
Add the following option/value when initializing the timeline:
const myTimeline = new MastodonTimeline({
instanceUrl: "https://mastodon.online",
});
It will show a timeline with posts from the instance mastodon.online
Profile timeline
Add the following options/values when initializing the timeline:
const myTimeline = new MastodonTimeline({
instanceUrl: "https://mastodon.online",
timelineType: "profile",
userId: "000180745",
profileName: "@idotj",
});
It will show a timeline with posts from my Mastodon profile @idotj
ℹ️ If you don't know your userId you have two ways to get it:
-
Copy the url below and paste it in a new tab. Remember to replace the words
INSTANCEandUSERNAMEwith your current values in the url:
https://INSTANCE/api/v1/accounts/lookup?acct=USERNAME
The first value you see in the list is youridnumber. -
Click on the link below and put your
@USERNAMEand@INSTANCEin the input field:
https://prouser123.me/mastodon-userid-lookup/
Hashtag timeline
Add the following options/values when initializing the timeline:
const myTimeline = new MastodonTimeline({
instanceUrl: "https://mastodon.online",
timelineType: "hashtag",
hashtagName: "fediverse",
});
It will show a timeline with posts containing the hashtag #fediverse
Customize
You can pass more options/values to personalize your timeline:
// Id of the <div> containing the timeline
mtContainerId: "mt-container",
// Mastodon instance Url (including https://)
instanceUrl: "https://mastodon.social",
// Choose type of posts to show in the timeline: 'local', 'profile', 'hashtag'. Default: local
timelineType: "local",
// Your user ID number on Mastodon instance. Leave it empty if you didn't choose 'profile' as type of timeline
userId: "",
// Your user name on Mastodon instance (including the @ symbol at the beginning). Leave it empty if you didn't choose 'profile' as type of timeline
profileName: "",
// The name of the hashtag (not including the # symbol). Leave it empty if you didn't choose 'hashtag' as type of timeline
hashtagName: "",
// Class name for the loading spinner (also used in CSS file)
spinnerClass: "mt-loading-spinner",
// Preferred color theme: 'light', 'dark' or 'auto'. Default: auto
defaultTheme: "auto",
// Maximum number of posts to request to the server. Default: 20
maxNbPostFetch: "20",
// Maximum number of posts to show in the timeline. Default: 20
maxNbPostShow: "20",
// Hide unlisted posts. Default: don't hide
hideUnlisted: false,
// Hide boosted posts. Default: don't hide
hideReblog: false,
// Hide replies posts. Default: don't hide
hideReplies: false,
// Hide video image preview and load video player instead. Default: don't hide
hideVideoPreview: false,
// Hide preview card if post contains a link, photo or video from a Url. Default: don't hide
hidePreviewLink: false,
// Hide custom emojis available on the server. Default: don't hide
hideEmojos: false,
// Converts Markdown symbol ">" at the beginning of a paragraph into a blockquote HTML tag. Default: don't apply
markdownBlockquote: false,
// Hide replies, boosts and favourites posts counter. Default: don't hide
hideCounterBar: false,
// Limit the text content to a maximum number of lines. Default: 0 (unlimited)
txtMaxLines: "0",
// Customize the text of the button used for showing/hiding sensitive/spolier text
btnShowMore: "SHOW MORE",
btnShowLess: "SHOW LESS",
// Customize the text of the button used for showing sensitive/spolier media content
btnShowContent: "SHOW CONTENT",
// Customize the text of the button pointing to the Mastodon page placed at the end of the timeline. Leave the value empty to hide it
btnSeeMore: "See more posts at Mastodon",
// Customize the text of the button reloading the list of posts placed at the end of the timeline. Leave the value empty to hide it
btnReload: "Refresh",
API
| Function | Description |
|---|---|
mtColorTheme(themeType) |
Apply a theme color. themeType accepts only two values: light or dark |
mtUpdate() |
Reload the timeline by fetching the lastest posts |
Examples
The folder examples/ contains several demos in HTML to play with. Download the full project and open each HTML file in your favorite browser.
Also, you have a Docker file to perform your tests if needed. Simply run:
docker compose up
Browser support
Mastodon embed timeline is supported on the latest versions of the following browsers:
- Chrome
- Firefox
- Edge
- Safari
- Brave
- Opera
🚀 Improve me
Feel free to add your features and improvements.
⚖️ License
GNU Affero General Public License v3.0
💬 FAQ
Check the closed issues, you might find your question there.
If nothing matches with your problem, check the open issues or feel free to create a new one.
Looking for a previous version of Mastodon embed timeline? Check on the tags list to see all the released versions: Tags version history