Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
Moderator Toolbox-NXG
Logo
Moderator Toolbox-NXG

User Guide

  • User Guide
    • Installation
    • Getting Started
    • Modules
      • General Settings
      • Modbar
      • Comment Nuke
      • Comments
      • Domain Tagger
      • History Button
      • Mod Macros
      • Mod Button
      • Notifier
      • Profile Pro
      • Training Mode & Second Opinions
      • Queue Overlay
      • Mod View Enhancements
      • Queue Tools
      • Removal Reasons
      • Subreddit Notes
      • Toolbox-NXG Config
      • Usernotes
      • Better Buttons
      • Comment Triage
      • Mass Moderation
      • Syntax Highlighter
      • Comment Actions
      • Mod Actions
      • Modmail
      • Shreddit
      • Old Reddit
      • Mod Log Matrix
      • Developer Tools
      • Support Module

Migrating from Toolbox

  • Migrating from Toolbox
    • Migrating from Original Toolbox
    • Schema Changes

Developer Guide

  • Developer Guide
    • Contributor Guidelines
    • Building and Testing
    • Releasing
    • Coding Style Guide
    • Project Structure
    • Writing a Toolbox Module
    • Function Parameter Conventions
    • Config Popup Style Guide
    • Publishing Announcements
    • API Reference
      • moderator-toolbox-nxg-for-reddit
      • moderator-toolbox-nxg-for-reddit
      • api/parsers/redditMutation
      • api/resources/comments
      • api/resources/flair
      • api/resources/listings
      • api/resources/me
      • api/resources/modSubs
      • api/resources/modmail
      • api/resources/modnotes
      • api/resources/modqueue
      • api/resources/relationships
      • api/resources/submissions
      • api/resources/subreddits
      • api/resources/things
      • api/resources/users
      • api/resources/wiki
      • api/resources/wikiVersioned
      • api/transport/http
      • api/transport/pagination
      • background
      • background/handlers/cache
      • background/handlers/cookieStore
      • background/handlers/globalmessage
      • background/handlers/keyedStore
      • background/handlers/modqueue
      • background/handlers/notifications
      • background/handlers/reload
      • background/handlers/settings
      • background/handlers/tabUtils
      • background/handlers/test-helpers
      • background/handlers/url_changed
      • background/handlers/usernotes
      • background/handlers/webrequest
      • background/messageHandling
      • background/messages
      • dom/oldReddit/comments
      • dom/oldReddit/page
      • dom/oldReddit/queue
      • dom/oldReddit/sidebar
      • dom/oldReddit/things
      • dom/shreddit/commentActionRow
      • dom/shreddit/commentThread
      • dom/shreddit/comments
      • dom/shreddit/feed
      • dom/shreddit/modNotes
      • dom/shreddit/queue
      • dom/shreddit/things
      • dom/shreddit/userpage
      • dom/uiLocations
      • framework/lifecycle
      • framework/loadConditions
      • framework/module
      • framework/moduleIds
      • framework/moduleRegistry
      • init
      • modules/announcements
      • modules/announcements/codec
      • modules/announcements/components/AnnouncementBuilderPopup
      • modules/announcements/components/AnnouncementCard
      • modules/announcements/components/AnnouncementManagerOverlay
      • modules/announcements/components/AnnouncementsPopup
      • modules/announcements/constants
      • modules/announcements/display
      • modules/announcements/dom
      • modules/announcements/noteUtils
      • modules/announcements/publish
      • modules/announcements/seen
      • modules/announcements/settings
      • modules/announcements/types
      • modules/betterbuttons
      • modules/betterbuttons/features/autoApprove
      • modules/betterbuttons/features/autoIgnoreReports
      • modules/betterbuttons/features/buttonUtils
      • modules/betterbuttons/features/commentLock
      • modules/betterbuttons/features/disposalGuard
      • modules/betterbuttons/features/distinguishToggle
      • modules/betterbuttons/features/modSave
      • modules/betterbuttons/features/removeButtons
      • modules/betterbuttons/features/removeConfirmation
      • modules/betterbuttons/features/stickyButtons
      • modules/betterbuttons/settings
      • modules/betterbuttons/store
      • modules/comment
      • modules/comment/components/ContextPopup
      • modules/comment/components/FlatViewOverlay
      • modules/comment/dom
      • modules/comment/oldReddit/hideModComments
      • modules/comment/oldReddit/hideOldComments
      • modules/comment/oldReddit/spamToggle
      • modules/comment/platformInterface
      • modules/comment/settings
      • modules/commentActions
      • modules/commentActions/components/CommentActions
      • modules/commentActions/dom
      • modules/commenttriage
      • modules/commenttriage/dom
      • modules/commenttriage/platformInterface
      • modules/commenttriage/settings
      • modules/config
      • modules/config/components/AddNewButton
      • modules/config/components/CompatibilityTab
      • modules/config/components/ConfigOverlay
      • modules/config/components/SettingsHomeTab
      • modules/config/components/WikiEditorFooter
      • modules/config/components/WikiEditorTab
      • modules/config/dom
      • modules/config/moduleapi
      • modules/config/settings
      • modules/devtools
      • modules/devtools/components/ApiInfoButton
      • modules/devtools/components/ApiInfoPopup
      • modules/devtools/components/CommentUITester
      • modules/devtools/dom
      • modules/devtools/settings
      • modules/domaintagger
      • modules/domaintagger/components/DomainTaggerPopup
      • modules/domaintagger/components/DomainTagsTab
      • modules/domaintagger/dom
      • modules/domaintagger/matching
      • modules/domaintagger/moduleapi
      • modules/domaintagger/schema
      • modules/domaintagger/settings
      • modules/general
      • modules/general/settings
      • modules/historybutton
      • modules/historybutton/components/HistoryButtonUserRoot
      • modules/historybutton/components/HistoryPopup
      • modules/historybutton/dom
      • modules/historybutton/moduleapi
      • modules/historybutton/schema
      • modules/historybutton/settings
      • modules/macros
      • modules/macros/components/MacroEditPopup
      • modules/macros/components/MacroSelect
      • modules/macros/components/ModMacroList
      • modules/macros/dom
      • modules/macros/moduleapi
      • modules/macros/schema
      • modules/macros/settings
      • modules/massmoderation
      • modules/massmoderation/components/ModtoolsToolbar
      • modules/massmoderation/oldReddit/queueModtools
      • modules/massmoderation/oldReddit/queueSidebarSorting
      • modules/massmoderation/oldReddit/queueSorting
      • modules/massmoderation/settings
      • modules/modactions
      • modules/modactions/components/FlatListModActions
      • modules/modactions/components/ItemHistoryPopup
      • modules/modactions/dom
      • modules/modactions/modLog
      • modules/modactions/recentActionsStore
      • modules/modbar
      • modules/modbar/components/ModBar
      • modules/modbar/components/MySubredditsPopup
      • modules/modbar/components/RecentActionsPopup
      • modules/modbar/dom
      • modules/modbar/features/settingsNavigation
      • modules/modbar/settings
      • modules/modbutton
      • modules/modbutton/components/BanForm
      • modules/modbutton/components/BanMacroTab
      • modules/modbutton/components/ModButtonPopup
      • modules/modbutton/components/ModButtonPopup.helpers
      • modules/modbutton/components/ModButtonUserRoot
      • modules/modbutton/components/SendModmailTab
      • modules/modbutton/components/SubredditRow
      • modules/modbutton/components/UserFlairTab
      • modules/modbutton/dom
      • modules/modbutton/schema
      • modules/modbutton/settings
      • modules/modmail
      • modules/modmail/dom
      • modules/modmail/settings
      • modules/modmatrix
      • modules/modmatrix/components/ActionFilter
      • modules/modmatrix/components/ControlsToolbar
      • modules/modmatrix/components/DrilldownPopover
      • modules/modmatrix/components/MatrixSettings
      • modules/modmatrix/components/MatrixStyleProvider
      • modules/modmatrix/components/MatrixTable
      • modules/modmatrix/components/ModMatrixApp
      • modules/modmatrix/components/ModeratorFilter
      • modules/modmatrix/components/Sparkline
      • modules/modmatrix/components/Toggle
      • modules/modmatrix/components/useDrilldownFetch
      • modules/modmatrix/components/useModLogFetch
      • modules/modmatrix/dom
      • modules/modmatrix/filterUtils
      • modules/modmatrix/schema
      • modules/modmatrix/settings
      • modules/modviewenhancements
      • modules/modviewenhancements/botIcon
      • modules/modviewenhancements/components/AutomodActionReason
      • modules/modviewenhancements/dom
      • modules/modviewenhancements/settings
      • modules/notifier
      • modules/notifier/poll
      • modules/notifier/settings
      • modules/notifier/store
      • modules/nukecomments
      • modules/nukecomments/components/NukeCommentsPopup
      • modules/nukecomments/dom
      • modules/nukecomments/schema
      • modules/nukecomments/settings
      • modules/oldreddit
      • modules/oldreddit/dom
      • modules/oldreddit/settings
      • modules/profile
      • modules/profile/components/BulkRemovePanel
      • modules/profile/components/BulkRemovePanel.helpers
      • modules/profile/components/ProfileButtonUserRoot
      • modules/profile/components/ProfileListingTab
      • modules/profile/components/ProfileOverlay
      • modules/profile/components/ProfileOverlay.helpers
      • modules/profile/components/UserSidebar
      • modules/profile/dom
      • modules/profile/settings
      • modules/proposals
      • modules/proposals/components/FrozenIntentSummary
      • modules/proposals/components/ProposalAuthorContext
      • modules/proposals/components/ProposalDetail
      • modules/proposals/components/ProposalFilterBar
      • modules/proposals/components/ProposalInlineBadge
      • modules/proposals/components/ProposalSpinner
      • modules/proposals/components/ProposalTargetPreview
      • modules/proposals/components/ProposalsButton
      • modules/proposals/components/ProposalsReviewPopup
      • modules/proposals/components/SecondOpinionToggle
      • modules/proposals/components/TrainingModeIndicator
      • modules/proposals/components/TrainingSettingsTab
      • modules/proposals/components/proposalFilter
      • modules/proposals/components/proposalView
      • modules/proposals/components/useItemProposalCount
      • modules/proposals/dom
      • modules/queue_overlay
      • modules/queue_overlay/components/QueueOverlay
      • modules/queue_overlay/dom
      • modules/queue_overlay/schema
      • modules/queue_overlay/settings
      • modules/queuetools
      • modules/queuetools/components/ActionsTable
      • modules/queuetools/components/DismissButtonRenderer
      • modules/queuetools/components/QueueItemTables
      • modules/queuetools/components/ReportsTable
      • modules/queuetools/components/hooks
      • modules/queuetools/dom
      • modules/queuetools/schema
      • modules/queuetools/settings
      • modules/removalreasons
      • modules/removalreasons/automodReasons
      • modules/removalreasons/components/MountEffect
      • modules/removalreasons/components/RemovalReasonList
      • modules/removalreasons/components/RemovalReasonsOverlay
      • modules/removalreasons/components/RemovalReasonsOverlay.helpers
      • modules/removalreasons/components/RemovalSettingsTab
      • modules/removalreasons/components/SortableReasonCard
      • modules/removalreasons/components/SuggestedReasonsTab
      • modules/removalreasons/dom
      • modules/removalreasons/features/submitRemoval
      • modules/removalreasons/moduleapi
      • modules/removalreasons/overlayOpener
      • modules/removalreasons/proposalAdapter
      • modules/removalreasons/schema
      • modules/removalreasons/settings
      • modules/removalreasons/suggested
      • modules/shared/modnotes/ModNotesPager
      • modules/shared/modnotes/NoteTableRow
      • modules/shared/modnotes/helpers
      • modules/shared/modnotes/schema
      • modules/shared/proposals/approveCapture
      • modules/shared/proposals/events
      • modules/shared/proposals/gateway
      • modules/shared/proposals/moduleapi
      • modules/shared/proposals/mutate
      • modules/shared/proposals/paths
      • modules/shared/proposals/reviewMode
      • modules/shared/proposals/selectors
      • modules/shared/proposals/setup
      • modules/shared/proposals/subreddits
      • modules/shared/proposals/traineeState
      • modules/shared/proposals/usernames
      • modules/shared/redditElements/TBComment
      • modules/shared/redditElements/TBSubmission
      • modules/shared/redditElements/deriveStatus
      • modules/shared/redditElements/thingParts
      • modules/shared/redditElements/types
      • modules/shared/removalReasons/DeliveryOption
      • modules/shared/removalReasons/parser
      • modules/shared/settings/SettingsDialog
      • modules/shared/settings/WikiLayoutSection
      • modules/shared/usernotes/archived
      • modules/shared/usernotes/messageLinkCache
      • modules/shared/usernotes/moduleapi
      • modules/shared/usernotes/noteMutations
      • modules/shared/usernotes/noteTypeColorStyle
      • modules/shared/usernotes/requireRules
      • modules/shared/usernotes/store
      • modules/shreddit
      • modules/shreddit/dom
      • modules/shreddit/settings
      • modules/subredditnotes
      • modules/subredditnotes/components/SubredditNotesButton
      • modules/subredditnotes/components/SubredditNotesPopup
      • modules/subredditnotes/components/TagInput
      • modules/subredditnotes/dom
      • modules/subredditnotes/helpers
      • modules/subredditnotes/moduleapi
      • modules/subredditnotes/settings
      • modules/support
      • modules/support/dom
      • modules/support/settings
      • modules/syntax
      • modules/syntax/dom
      • modules/syntax/settings
      • modules/syntax/syntaxThemes
      • modules/usernotes
      • modules/usernotes/components/AddUserNotePopup
      • modules/usernotes/components/CombinedNoteTag
      • modules/usernotes/components/ModNotesBadge
      • modules/usernotes/components/ModNotesUserRoot
      • modules/usernotes/components/PruneUserNotesPopup
      • modules/usernotes/components/UserNotesManagerOverlay
      • modules/usernotes/components/UserNotesManagerOverlay.helpers
      • modules/usernotes/components/UsernoteTag
      • modules/usernotes/components/UsernoteTypeList
      • modules/usernotes/components/UsernotesSettingsTab
      • modules/usernotes/csvExport
      • modules/usernotes/dom
      • modules/usernotes/settings
      • shared/app/AppRoot
      • shared/app/ErrorBoundary
      • shared/app/PageNotificationContainer
      • shared/app/SpinnerContainer
      • shared/app/TBContextMenu
      • shared/app/TextFeedbackContainer
      • shared/controls/ActionButton
      • shared/controls/ActionSelect
      • shared/controls/AuthorButton
      • shared/controls/CheckboxInput
      • shared/controls/EnforcementModeRadio
      • shared/controls/FlatListAction
      • shared/controls/GeneralButton
      • shared/controls/GeneralInlineButton
      • shared/controls/Icon
      • shared/controls/IsModGuard
      • shared/controls/ListInput
      • shared/controls/MapInput
      • shared/controls/ModbarButton
      • shared/controls/NormalInput
      • shared/controls/NumberInput
      • shared/controls/ReactAlert
      • shared/controls/RelativeTime
      • shared/controls/SelectInput
      • shared/controls/SingleSelect
      • shared/controls/SortToggleButton
      • shared/controls/SubredditMultiSelect
      • shared/controls/SubredditSelect
      • shared/controls/TextareaInput
      • shared/controls/TokenChips
      • shared/controls/useIsMod
      • shared/window/Backdrop
      • shared/window/FullPageDialog
      • shared/window/Pager
      • shared/window/PushDrawer
      • shared/window/SettingRow
      • shared/window/ShadowPortal
      • shared/window/TabBar
      • shared/window/TabbedDialog
      • shared/window/Window
      • shared/window/WindowTabs
      • store
      • store/contextMenu
      • store/contextMenuSlice
      • store/feedback
      • store/settingsSlice
      • store/spinnerSlice
      • store/textFeedbackSlice
      • types/snuownd
      • types/tinycolor2
      • util/data/array
      • util/data/assertNever
      • util/data/async
      • util/data/color
      • util/data/encoding
      • util/data/iter
      • util/data/positionalJson
      • util/data/pubsub
      • util/data/purify
      • util/data/string
      • util/data/time
      • util/infra/buildenv
      • util/infra/captureGuard
      • util/infra/debug
      • util/infra/logging
      • util/infra/perKeyQueue
      • util/infra/platform
      • util/infra/version
      • util/persistence/cache
      • util/persistence/settings
      • util/persistence/settingsMigrations
      • util/persistence/settingsPortability
      • util/reddit/events
      • util/reddit/modActions
      • util/reddit/pageContext
      • util/reddit/profileSubreddit
      • util/reddit/reddit-domain
      • util/reddit/thingInfo
      • util/ui/codemirrorSetup
      • util/ui/dom
      • util/ui/drawPosition
      • util/ui/highlight
      • util/ui/hooks
      • util/ui/icons
      • util/ui/listener
      • util/ui/markdown
      • util/ui/navigation
      • util/ui/notifications
      • util/ui/reactMount
      • util/ui/redditElementsInit
      • util/ui/toolboxContainer
      • util/wiki/mutateWikiPage
      • util/wiki/schemas/config/codec
      • util/wiki/schemas/config/reconcile
      • util/wiki/schemas/config/schema
      • util/wiki/schemas/config/validation
      • util/wiki/schemas/domaintags/codec
      • util/wiki/schemas/domaintags/schema
      • util/wiki/schemas/proposals/codec
      • util/wiki/schemas/proposals/schema
      • util/wiki/schemas/shared/tokens
      • util/wiki/schemas/subredditnotes/codec
      • util/wiki/schemas/subredditnotes/schema
      • util/wiki/schemas/usernotes/codec
      • util/wiki/schemas/usernotes/reconcile
      • util/wiki/schemas/usernotes/schema
      • util/wiki/schemas/usernotes/sharded
      • util/wiki/schemas/usernotes/sharding
      • util/wiki/wikiConstants
      • util/wiki/wikiLayoutCache
      • util/wiki/wikiMigration
      • util/wiki/wikiPaths

Schema Reference

  • Schema Reference
    • Subreddit Config Schema
    • Domain Tags Schema
    • Usernotes Schema
    • Usernotes Shard Pages
    • Subreddit Notes Schema
    • Proposals Schema

Legal

  • Privacy Policy
Back to top
View this page
Edit this page

Developer GuideΒΆ

Documentation for contributors and developers working on Toolbox-NXG.

  • Contributor Guidelines
  • Building and Testing
  • Releasing
  • Coding Style Guide
  • Project Structure
  • Writing a Toolbox Module
  • Function Parameter Conventions
  • Config Popup Style Guide
  • Publishing Announcements
  • API Reference
Next
Contributor Guidelines
Previous
Schema Changes
Copyright © The Toolbox-NXG Contributors
Made with Sphinx and @pradyunsg's Furo