mirror/Vencord
1
0
Fork 0
mirror of https://github.com/Vendicated/Vencord.git synced 2025-02-24 15:35:11 +00:00
Code Issues Projects Releases Packages Wiki Activity

Styles: update documentation

Browse source
This commit is contained in:
Sqaaakoi 2025-01-20 09:50:49 +13:00
parent b49bc23992
commit 9a44ab6046
No known key found for this signature in database
1 changed files with 5 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
src/api/Styles.ts
View file

@ -39,7 +39,7 @@ function findDocuments() {
} }
/** /**
* A style's name can be obtained from importing a stylesheet with `?managed` at the end of the import * A style object can be obtained by importing a stylesheet with `?managed` at the end of the import
* @param style The style object or name * @param style The style object or name
* @returns `false` if the style was already enabled, `true` otherwise * @returns `false` if the style was already enabled, `true` otherwise
* @example * @example
@ -62,7 +62,7 @@ export function enableStyle(style: Style | string) {
/** /**
* @param style The style object or name * @param style The style object or name
* @returns `false` if the style was already disabled, `true` otherwise * @returns `false` if the style was already disabled or cannot be found, `true` otherwise
* @see {@link enableStyle} for info on importing managed styles * @see {@link enableStyle} for info on importing managed styles
*/ */
export function disableStyle(style: Style | string) { export function disableStyle(style: Style | string) {
@ -84,6 +84,7 @@ export function disableStyle(style: Style | string) {
} }
/** /**
* Set a style and update it.
* @param style The new style object * @param style The new style object
* @see {@link enableStyle} for info on importing managed styles * @see {@link enableStyle} for info on importing managed styles
*/ */
@ -182,7 +183,7 @@ export function updateStyleInDocument(style: Style, doc: Document) {
} }
/** /**
* Updates styles in the DOM of all documents * Updates a style in the DOM of all documents
* @param style A style object * @param style A style object
* @see {@link setStyleClassNames} for more info on style classnames * @see {@link setStyleClassNames} for more info on style classnames
*/ */
@ -191,7 +192,7 @@ export function compileStyle(style: Style) {
} }
/** /**
* Updates styles in the DOM of all documents * Adds all enabled styles to the DOM of all documents
* @param doc The document to add styles to * @param doc The document to add styles to
* @see {@link setStyleClassNames} for more info on style classnames * @see {@link setStyleClassNames} for more info on style classnames
*/ */