AO3Boxicons

Reusable library that initialized the boxicons css and serves functions to turn stats and menus into icons

This script should not be not be installed directly. It is a library for other scripts to include with the meta directive // @require https://update.greasyfork.org/scripts/497064/1388954/AO3Boxicons.js

Author
genusslicht
Version
1.0
Created
2024-06-04
Updated
2024-06-04
License
MIT

Basic Usage

  • Create a new User Script
  • add @required Tag with the newest version of this lib
  • Add to body:
(function () {
  const settings = {
    iconifyStats: true,
    iconifyUserNav: true
  };
  IconifyAO3(settings);
})();

Will turn the Stat names and the user navigation links into icons.

Settings

All described properties have to be in the settings object that is given to IconifyAO3.

  • boxiconsVersion: String - used version of boxicons. (current is "2.1.4", check boxicons.com for updates)
  • webFontsUri: String - Uri to a webfont that will be imported via CSS if set. See google web fonts for guidance. (!!! NO GOOGLE TRACKING IS ADDED IF LEFT UNSET !!!)
  • iconifyStats: Boolean - if set to true, stat titles will be turned into icons.
  • statsSettings: Object - sets individual options for stat icons. See below.
  • iconifyUserNav: Boolean - if set to true, user navigation texts will be turned into icons.
  • userNavSettings: Object - sets individual options for user nav icons. See below.

Individual Stat Icons

Define individual icons and tooltips, using the statsSettings object.

Properties

  • iconClass: String - name of boxicon icon (see https://boxicons.com)
  • solid: Boolean - sets the icon as solid or not. See selected icon properties on https://boxicons.com
  • tooltip: String - description that shows on mouse hover. Default is stats titles.

Example

{
  statsSettings: {
    kudosOptions: { solid: false }
  }
}

Will turn the solid heart for kudos into an unsolid heart. Note that the default settings will stay intact if not overwritten here.

List of possible Options

wordCountOptions, chaptersOptions, collectionsOptions, commentsOptions, kudosOptions, bookmarksOptions, hitsOptions, workSubsOptions, authorSubsOptions, commentThreadsOptions, fandomsOptions, workCountOptions, seriesCompleteOptions, kudos2HitsOptions,timeToReadOptions,dateWorkPublishedOptions, dateWorkUpdateOptions, dateWorkCompleteOptions

Individual User Navigation Icons

Define individual icons and tooltips, using the userNavSettings object.

Properties

  • iconClass: String - name of boxicon icon (see https://boxicons.com)
  • solid: Boolean - sets the icon as solid or not. See selected icon properties on https://boxicons.com
  • tooltip: String - description that shows on mouse hover.

Example

{
  userNavSettings: {
    accountOptions: { iconClass: "user-rectangle" }
  }
}

Will turn the round user icon into a rectangular one. Note that the default settings will stay intact if not overwritten here.

List of possible Options

accountOptions, postNewOptions, logoutOptions