Skip to main content
Home

latest
Works with
This package works with Deno, BrowsersIt is unknown whether this package works with Cloudflare Workers, Node.js, Bun
It is unknown whether this package works with Cloudflare Workers
It is unknown whether this package works with Node.js
This package works with Deno
It is unknown whether this package works with Bun
This package works with Browsers
JSR Score41%
Publisheda year ago (4.1.5)
T
UpdateNoticeConfiguration
No documentation available
f
default
No documentation available
v
BuildName
No documentation available
v
BuildReleaseLocation
No documentation available
v
BuildVersion
No documentation available
v
SpicetifyEntryPoint
No documentation available
v
SpicetifyEntryPointPath
No documentation available
f
default
No documentation available
f
TestReleaseAutoUpdater
No documentation available
f
Remove
No documentation available
f
Store
No documentation available
f
default
No documentation available
T
ExpirationSettings
No documentation available
f
GetDynamicStoreItem
No documentation available
f
GetExpireStore
No documentation available
f
GetInstantStore
No documentation available
f
SetDynamicStoreItem
No documentation available
f
AddToPlaylist
No documentation available
f
CreateFolder
No documentation available
f
CreatePlaylist
No documentation available
f
GetPlaylistContents
No documentation available
f
GetPlaylistDetails
No documentation available
f
GetPlaylistsAndFolders
No documentation available
f
RemoveFromPlaylist
No documentation available
T
DJMetadata
No documentation available
f
GetDurationString
No documentation available
f
GetTimestampString
No documentation available
v
HasIsLikedLoaded
No documentation available
v
HaveSongDetailsLoaded
No documentation available
v
HaveSongLyricsLoaded
No documentation available
v
IsLiked
No documentation available
v
IsLikedChanged
No documentation available
v
IsPlaying
No documentation available
v
IsPlayingChanged
No documentation available
v
IsShuffling
No documentation available
v
IsShufflingChanged
No documentation available
T
LoadedSongDetails
No documentation available
T
LocalSongDetails
No documentation available
T
LocalSongMetadata
No documentation available
v
LoopMode
No documentation available
v
LoopModeChanged
No documentation available
T
RomanizedLanguage
No documentation available
f
SeekTo
No documentation available
f
SetIsLiked
No documentation available
f
SetIsPlaying
No documentation available
f
SetIsShuffling
No documentation available
f
SetLoopMode
No documentation available
v
Song
No documentation available
v
SongChanged
No documentation available
v
SongContext
No documentation available
v
SongContextChanged
No documentation available
T
SongContextDetails
No documentation available
v
SongDetails
No documentation available
v
SongDetailsLoaded
No documentation available
v
SongLyrics
No documentation available
v
SongLyricsLoaded
No documentation available
T
SongMetadata
No documentation available
v
Timestamp
No documentation available
T
v
TimeStepped
No documentation available
T
TransformedLyrics
No documentation available
f
GetSpotifyAccessToken
No documentation available
v
GlobalMaid
No documentation available
T
HistoryLocation
No documentation available
v
IsDevelopment
No documentation available
v
OnSpotifyReady
No documentation available
f
ShowNotification
No documentation available
v
Spotify
No documentation available
f
SpotifyFetch
No documentation available
v
SpotifyInternalFetch
No documentation available
v
SpotifyPlatform
No documentation available
v
SpotifyPlaybar
No documentation available
v
SpotifyPlayer
No documentation available
v
SpotifyRequestBuilder
No documentation available
v
SpotifySnackbar
No documentation available
v
SpotifyURI
No documentation available
f
Apply
No documentation available
f
GetSpicetifyDirectory
No documentation available
f
GetSpicetifyExtensionsDirectory
No documentation available
f
RemoveExtension
No documentation available
f
ToggleExtension
No documentation available
N
default
No documentation available
f
default.addToQueue

Adds a track or array of tracks to prioritized queue.

T
default.Album
No documentation available
N
default.AppTitle

Interface for interacting with Spotify client's app title

f
default.AppTitle.get

Get current default app title

f
default.AppTitle.reset

Reset app title to default

f
default.AppTitle.set

Set default app title. This has no effect if the player is running. Will override any previous forced title.

f
default.AppTitle.sub

Subscribe to title changes. This event is not fired when the player changes app title.

T
default.ArtistsEntity
No documentation available
f
default.classnames

classnames

f
default.colorExtractor

Fetch interesting colors from URI.

T
default.ColorSet
No documentation available
N
default.Config

A filtered copy of user's config-xpui file.

v
default.Config.color_scheme
No documentation available
v
default.Config.current_theme
No documentation available
v
default.Config.custom_apps
No documentation available
v
default.Config.extensions
No documentation available
v
default.Config.version
No documentation available
N
default.ContextMenu

Create custom menu item and prepend to right click context menu

T
default.ContextMenu.OnClickCallback
No documentation available
T
default.ContextMenu.ShouldAddCallback
No documentation available
c
default.ContextMenu.SubMenu

Create a sub menu to contain Items. Items in subItems array shouldn't be registered.

T
default.ContextTrack
No documentation available
N
default.CosmosAsync

Async wrappers of CosmosAPI

T
default.CosmosAsync.Body
No documentation available
f
default.CosmosAsync.del
No documentation available
f
default.CosmosAsync.get
No documentation available
f
default.CosmosAsync.head
No documentation available
T
default.CosmosAsync.Headers
No documentation available
T
default.CosmosAsync.Method
No documentation available
f
default.CosmosAsync.patch
No documentation available
f
default.CosmosAsync.post
No documentation available
f
default.CosmosAsync.postSub
No documentation available
f
default.CosmosAsync.put
No documentation available
f
default.CosmosAsync.request
No documentation available
f
default.CosmosAsync.resolve
No documentation available
f
default.CosmosAsync.sub
No documentation available
T
default.CSSColors
No documentation available
f
default.extractColorPreset

Analyse and extract color presets from an image. Works for any valid image URL/URI.

f
default.getAudioData

Fetch track analyzed audio data. Beware, not all tracks have audio data.

f
default.getFontStyle

Return font styling used by Spotify.

N
default.GraphQL

Spicetify's QraphQL wrapper for Spotify's GraphQL API endpoints

v
default.GraphQL.Context

Context for GraphQL queries.

v
default.GraphQL.Definitions

Collection of GraphQL definitions.

f
default.GraphQL.Handler

Handler for GraphQL queries.

v
default.GraphQL.MutationDefinitions

GraphQL mutation definitions. Subset of Definitions that are used as mutation requests.

T
default.GraphQL.Query

Possible types of entities.

v
default.GraphQL.QueryDefinitions

GraphQL query definitions. Subset of Definitions that are used as query requests.

f
default.GraphQL.Request

Sends a GraphQL query to Spotify.

v
default.GraphQL.ResponseDefinitions

GraphQL response definitions. Subset of Definitions that are used as response types.

I
default.hsl
No documentation available
I
default.hsv
No documentation available
T
default.Icon
No documentation available
T
default.ImagesEntity
No documentation available
N
default.Keyboard

Set of APIs method to register, deregister hotkeys/shortcuts

f
default.Keyboard._deregisterShortcut
No documentation available
f
default.Keyboard.changeShortcut
No documentation available
f
v
default.Keyboard.KEYS
No documentation available
T
default.Keyboard.KeysDefine
No documentation available
f
default.Keyboard.registerImportantShortcut
No documentation available
f
default.Keyboard.registerIsolatedShortcut
No documentation available
f
default.Keyboard.registerShortcut
No documentation available
T
default.Keyboard.ValidKey
No documentation available
N
default.Locale

Spotify internal library for localization

v
default.Locale._dateTimeFormats

Registered date time formats in the current session

v
default.Locale._dictionary

Dictionary of localized strings

v
default.Locale._locale

Current locale of the client

v
default.Locale._relativeTimeFormat

Relative time format

v
default.Locale._supportedLocales

Collection of supported locales

v
default.Locale._urlLocale
No documentation available
f
default.Locale.formatDate

Format date into locale string

f
default.Locale.formatNumber

Format number into locale string

f
default.Locale.formatNumberCompact

Format number into compact locale string

f
default.Locale.formatRelativeTime

Format time into relative locale string

f
default.Locale.get

Get localized string

f
default.Locale.getDateTimeFormat

Get date time format of the passed options.

f
default.Locale.getDictionary

Get the current locale dictionary

f
default.Locale.getLocale

Get the current locale

f
default.Locale.getRelativeTimeFormat

Get the current relative time format

f
default.Locale.getSeparator

Get the separator for the current locale

f
default.Locale.getSmartlingLocale

Get the current locale code for Smartling

f
default.Locale.getUrlLocale

Get the current locale code for URL

f
default.Locale.setDictionary

Set the dictionary for the current locale

f
default.Locale.setLocale

Set the current locale

f
default.Locale.setUrlLocale

Set the current locale code for URL

f
default.Locale.toLocaleLowerCase

Transform text into locale lowercase

f
default.Locale.toLocaleUpperCase

Transform text into locale uppercase

N
default.LocalStorage
No documentation available
f
default.LocalStorage.clear

Empties the list associated with the object of all key/value pairs, if there are any.

f
default.LocalStorage.get

Get key value

f
default.LocalStorage.set

Set new value for key

N
default.Menu

To create and prepend custom menu item in profile menu.

c
default.Menu.SubMenu

Create a sub menu to contain Item toggles. Items in subItems array shouldn't be registered.

T
default.Metadata
No documentation available
f
default.Mousetrap

Keyboard shortcut library

v
default.Platform

Contains vast array of internal APIs. Please explore in Devtool Console.

N
default.Playbar

Add button in player controls

N
default.Player
No documentation available
f
default.Player.addEventListener

Register a listener type on Spicetify.Player.

f
default.Player.back

Skip to previous track.

v
default.Player.data

An object contains all information about current track and player.

f
default.Player.decreaseVolume

Decrease a small amount of volume.

f
default.Player.dispatchEvent

Dispatches an event at Spicetify.Player.

v
default.Player.eventListeners
No documentation available
f
default.Player.formatTime

Convert milisecond to mm:ss format

f
default.Player.getDuration

Return song total duration in milisecond.

f
default.Player.getHeart

Return track heart state.

f
default.Player.getMute

Return mute state

f
default.Player.getProgress

Return elapsed duration in milisecond.

f
default.Player.getProgressPercent

Return elapsed duration in percentage (0 to 1).

f
default.Player.getRepeat

Return current Repeat state (No repeat = 0/Repeat all = 1/Repeat one = 2).

f
default.Player.getShuffle

Return current shuffle state.

f
default.Player.getVolume

Return current volume level (0 to 1).

f
default.Player.increaseVolume

Increase a small amount of volume.

f
default.Player.isPlaying

Return a boolean whether player is playing.

f
default.Player.next

Skip to next track.

f
default.Player.pause

Pause track.

f
default.Player.play

Resume track.

f
default.Player.playUri

Play a track, playlist, album, etc. immediately

f
default.Player.removeEventListener

Unregister added event listener type.

f
default.Player.seek

Seek track to position.

f
default.Player.setHeart

Set track heart state.

f
default.Player.setMute

Turn mute on/off

f
default.Player.setRepeat

Change Repeat mode

f
default.Player.setShuffle

Turn shuffle on/off.

f
default.Player.setVolume

Set volume level

f
default.Player.skipBack

Seek to previous amount of milisecond

f
default.Player.skipForward

Seek to next amount of milisecond

f
default.Player.toggleHeart

Toggle Heart (Favourite) track state.

f
default.Player.toggleMute

Toggle Mute/No mute.

f
default.Player.togglePlay

Toggle Play/Pause.

f
default.Player.toggleRepeat

Toggle No repeat/Repeat all/Repeat one.

f
default.Player.toggleShuffle

Toggle Shuffle/No shuffle.

T
default.PlayerContext
No documentation available
T
N
default.PopupModal

Popup Modal

I
f
default.PopupModal.display
No documentation available
f
default.PopupModal.hide
No documentation available
v
default.Queue

Queue object contains list of queuing tracks, history of played tracks and current track metadata.

v
default.React

React instance to create components

N
default.ReactComponent

Stock React components exposed from Spotify library

v
default.ReactComponent.AlbumMenu

Tailored ReactComponent.Menu for specific type of object

v
default.ReactComponent.ArtistMenu
No documentation available
v
default.ReactComponent.ButtonPrimary

Component to render Spotify primary button

v
default.ReactComponent.ButtonSecondary

Component to render Spotify secondary button

v
default.ReactComponent.ButtonTertiary

Component to render Spotify tertiary button

v
default.ReactComponent.ConfirmDialog

Component to render Spotify-style confirm dialog

v
default.ReactComponent.ContextMenu

Generic context menu provider

v
default.ReactComponent.IconComponent

Component to render Spotify-style icon

v
default.ReactComponent.Menu

Outer layer contain ReactComponent.MenuItem(s)

v
default.ReactComponent.MenuItem

Component to construct menu item Used as ReactComponent.Menu children

v
default.ReactComponent.PlaylistMenu
No documentation available
v
default.ReactComponent.PodcastShowMenu
No documentation available
v
default.ReactComponent.RightClickMenu

Wrapper of ReactComponent.ContextMenu with props: action = 'toggle' and trigger = 'right-click'

v
default.ReactComponent.Slider

Component to render Spotify slider

v
default.ReactComponent.TextComponent

Component to render Spotify-style text

v
default.ReactComponent.TooltipWrapper

Component to display tooltip when hovering over element Useful for accessibility

v
default.ReactComponent.TrackMenu
No documentation available
v
default.ReactDOM

React DOM instance to render and mount components

v
default.ReactDOMServer

React DOM Server instance to render components to string

N
default.ReactFlipToolkit

react-flip-toolkit

v
default.ReactFlipToolkit.Flipped
No documentation available
v
default.ReactFlipToolkit.Flipper
No documentation available
v
default.ReactFlipToolkit.spring
No documentation available
N
default.ReactHook
No documentation available
f
default.ReactHook.DragHandler

React Hook to create interactive drag-and-drop element

f
default.ReactHook.useExtractedColor

React Hook to use extracted color from GraphQL

v
default.ReactQuery

React Query v3

f
default.removeFromQueue

Remove a track or array of tracks from current queue.

I
default.rgb
No documentation available
T
default.SemanticColor
No documentation available
f
default.showNotification

Display a bubble of notification. Useful for a visual feedback.

v
default.SVGIcons

SVG icons

v
default.Tippy

Tippy.js instance used by Spotify

v
default.TippyProps

Spicetify's predefined props for Tippy.js Used to mimic Spotify's tooltip behavior

N
default.Topbar

Add button in top bar next to navigation buttons

T
default.Variant
No documentation available
v
default.BridgeAPI
No documentation available
v
default.CosmosAPI
No documentation available
f
default.getAblumArtColors
No documentation available
v
default.LiveAPI
No documentation available

Report package

Please provide a reason for reporting this package. We will review your report and take appropriate action.

Please review the JSR usage policy before submitting a report.