No description
Find a file
2024-05-23 10:53:56 +02:00
.firefox-profile Add empty .firefox-profile 2023-05-31 19:52:33 +02:00
.github/workflows Delete Firefox release foo from release job 2023-07-17 13:07:39 +02:00
.vscode Setup eslint/prettier configuration 2023-06-21 15:14:36 +02:00
documentation overhaul readme.md 2023-05-28 12:18:37 +02:00
scripts do not minify extension code 2023-07-10 19:00:54 +02:00
src remove code i wanted to remove in an earlier commit 2024-05-23 10:53:56 +02:00
tests match capitalised pronouns in bio 2023-07-18 12:24:08 +02:00
.eslintrc.yaml Add several additional, but very helpful rules 2023-06-21 15:14:36 +02:00
.gitignore Add empty .firefox-profile 2023-05-31 19:52:33 +02:00
.node-version initial commit 2023-05-24 18:47:04 +02:00
jsconfig.json Lay out the base work for unit tests 2023-07-11 00:08:50 +02:00
LICENSE.md Format files using prettier 2023-05-25 22:20:11 +00:00
package-lock.json Setup HTML sanitizing 2023-07-11 00:08:50 +02:00
package.json update version number 2023-07-18 11:25:54 +02:00
README.md update version number 2023-08-17 22:33:01 +02:00

ProToots

A Firefox extension which displays an author's pronouns next to their name on Mastodon. (Now in even more places!)

A Mastodon screenshot showing off pronouns next to a person's name


Download/Installation

The extension is available on the firefox store! (we're working on chrome)

Alternatively you can download an unsigned version from the releases page.


Known issues

  • None! It's perfect!
  • no but seriously, please submit any bugs you find as an issue :3

Please also take a look at the FAQ below and the issue list.


FAQ

Why does ProToots need permission for all websites?

The addon needs to determine whether or not the site you are currently browsing is a Mastodon server. For that to work, it requires access to all sites. Otherwise, each existing Mastodon server would have to be explicitly added.

Why can't I see any ProPlates?

It is likely your instance is not supported. This is because forks of Mastodon all work slightly differently and we cannot account for every version out there.
If ProToots isn't working on your instance please tell your admins to contact us here on Github.

ProPlates don't have a background/low contrast on my instance.

Mastodon does not provide set variables for element colors, so we have to adjust the plate styling to each theme. If they're not displaying correctly please tell your admins to follow these steps to style ProPlates.

Somebody has added/changed pronouns, why is ProToots still showing no/their old pronouns?

In order to strain your instance less pronouns are cached for 24h, so it might take up to a day to see this change reflected.
Alternatively you can simply hit the "Reset cache" button in the addon settings.

When an author only provides their pronouns as a pronouns.page link we display that instead. In the future we'll be able to extract pronouns from the given link. (See #7)


Instance admin info

Protoots aren't working on my instance

Currently ProToots only looks for specific classes and IDs. If your instance has changed the name of those, ProToots will not find them.
Especially the parent div with id 'Mastodon' is important, since without that no other code will run.
Please open an issue with your server name and info on which names you've changed, so we can add support for your instance.
We're also working on a way to more easily support many different types of fedi software, such as Misskey or Akkoma. See #12

How do I style ProPlates to correctly display on my themes?

You can set their background-color and color attribute for each theme.
To do this simply add some CSS to your server. Here's how.
See our default styles for reference.


Developer setup

  • Clone the repository
  • Install the required dependencies using npm install
  • Start the development workflow with npm start
  • Build with npm run package
  • Mess around with with protoots.js
  • Trans rights!