add docstrings for components beginning with Sk, along with DynamicNotes

This commit is contained in:
bunnybeam 2025-07-17 17:38:45 +01:00
parent 05a499ac55
commit 184d116632
No known key found for this signature in database
30 changed files with 62 additions and 0 deletions

View file

@ -1,6 +1,8 @@
<!--
SPDX-FileCopyrightText: hazelnoot and other Sharkey contributors
SPDX-License-Identifier: AGPL-3.0-only
Displays a note with either Misskey or Sharkey style, based on user preference.
-->
<template>

View file

@ -1,6 +1,8 @@
<!--
SPDX-FileCopyrightText: hazelnoot and other Sharkey contributors
SPDX-License-Identifier: AGPL-3.0-only
Displays a note in the detailed view with either Misskey or Sharkey style, based on user preference.
-->
<template>

View file

@ -1,6 +1,8 @@
<!--
SPDX-FileCopyrightText: hazelnoot and other Sharkey contributors
SPDX-License-Identifier: AGPL-3.0-only
Displays a note in the simple view with either Misskey or Sharkey style, based on user preference.
-->
<template>

View file

@ -1,6 +1,8 @@
<!--
SPDX-FileCopyrightText: marie and other Sharkey contributors
SPDX-License-Identifier: AGPL-3.0-only
Displays an account pending approval, with the signup reason and buttons to approve or delete it.
-->
<template>

View file

@ -1,6 +1,8 @@
<!--
SPDX-FileCopyrightText: hazelnoot and other Sharkey contributors
SPDX-License-Identifier: AGPL-3.0-only
Horizontal strip that displays a user's badges.
-->
<template>

View file

@ -1,6 +1,8 @@
<!--
SPDX-FileCopyrightText: hazelnoot and other Sharkey contributors
SPDX-License-Identifier: AGPL-3.0-only
List of items, divided by date separators.
-->
<template>

View file

@ -1,6 +1,8 @@
<!--
SPDX-FileCopyrightText: hazelnoot and other Sharkey contributors
SPDX-License-Identifier: AGPL-3.0-only
List of errors for a viewed note.
-->
<template>

View file

@ -1,6 +1,8 @@
<!--
SPDX-FileCopyrightText: hazelnoot and other Sharkey contributors
SPDX-License-Identifier: AGPL-3.0-only
Fetches and displays a note from a note ID.
-->
<template>

View file

@ -1,6 +1,8 @@
<!--
SPDX-FileCopyrightText: CenTdemeern1 and other Sharkey contributors
SPDX-License-Identifier: AGPL-3.0-only
Displays a Flash Player window via Ruffle.
-->
<template>

View file

@ -1,6 +1,8 @@
<!--
SPDX-FileCopyrightText: hazelnoot and other Sharkey contributors
SPDX-License-Identifier: AGPL-3.0-only
Selectable entry on the "Following" feed, displaying a user with their most recent note.
-->
<template>

View file

@ -1,6 +1,8 @@
<!--
SPDX-FileCopyrightText: hazelnoot and other Sharkey contributors
SPDX-License-Identifier: AGPL-3.0-only
List of a user's recent notes, to display on the "Following" feed.
-->
<template>

View file

@ -1,6 +1,8 @@
<!--
SPDX-FileCopyrightText: dakkar, MoshiBar, and other Sharkey contributors
SPDX-License-Identifier: AGPL-3.0-only
Renders a KaTeX formula.
-->
<template>

View file

@ -1,6 +1,8 @@
<!--
SPDX-FileCopyrightText: syuilo and other misskey contributors
SPDX-License-Identifier: AGPL-3.0-only
Small label that displays the name and icon of an instance.
-->
<template>

View file

@ -1,6 +1,8 @@
<!--
SPDX-FileCopyrightText: marie and other Sharkey contributors
SPDX-License-Identifier: AGPL-3.0-only
Displays a sheet of info about MFM.
-->
<template>

View file

@ -1,6 +1,8 @@
<!--
SPDX-FileCopyrightText: puniko and other Sharkey contributors
SPDX-License-Identifier: AGPL-3.0-only
Media player for module files. Displays the pattern in real time as it plays.
-->
<template>

View file

@ -1,6 +1,8 @@
<!--
SPDX-FileCopyrightText: hazelnoot and other Sharkey contributors
SPDX-License-Identifier: AGPL-3.0-only
Displays a placeholder for a muted note.
-->
<template>

View file

@ -1,6 +1,8 @@
<!--
SPDX-FileCopyrightText: syuilo and misskey-project
SPDX-License-Identifier: AGPL-3.0-only
Displays a note. Used to show the "main" note in a given context.
-->
<template>

View file

@ -1,6 +1,8 @@
<!--
SPDX-FileCopyrightText: syuilo and other misskey contributors
SPDX-License-Identifier: AGPL-3.0-only
Detailed view of a note. Used when opening a note onto its own page.
-->
<template>

View file

@ -1,6 +1,8 @@
<!--
SPDX-FileCopyrightText: marie and other Sharkey contributors
SPDX-License-Identifier: AGPL-3.0-only
Header for a note, displaying info such as username and creation timestamp.
-->
<template>

View file

@ -1,6 +1,8 @@
<!--
SPDX-FileCopyrightText: syuilo and other misskey contributors
SPDX-License-Identifier: AGPL-3.0-only
Simple view of a note. Used in quote renotes, link previews, etc.
-->
<template>

View file

@ -1,6 +1,10 @@
<!--
SPDX-FileCopyrightText: marie and other Sharkey contributors
SPDX-License-Identifier: AGPL-3.0-only
Displays a sub-note. Used to display secondary notes in a given context.
For example, when viewing a reply on the timeline, SkNoteSub will be used to display the note that is being replied to.
-->
<template>

View file

@ -1,6 +1,8 @@
<!--
SPDX-FileCopyrightText: hazelnoot and other Sharkey contributors
SPDX-License-Identifier: AGPL-3.0-only
Displays a translated version of a note.
-->
<template>

View file

@ -1,6 +1,8 @@
<!--
SPDX-FileCopyrightText: marie and other Sharkey contributors
SPDX-License-Identifier: AGPL-3.0-only
Displays an old version of an edited note.
-->
<template>

View file

@ -1,6 +1,8 @@
<!--
SPDX-FileCopyrightText: kopper and other Sharkey contributors
SPDX-License-Identifier: AGPL-3.0-only
Displays Oneko, a cat that follows the cursor.
-->
<template>

View file

@ -1,6 +1,8 @@
<!--
SPDX-FileCopyrightText: hazelnoot and other Sharkey contributors
SPDX-License-Identifier: AGPL-3.0-only
Allows a user to write text to test their word mutes against, returning matched words.
-->
<template>

View file

@ -1,6 +1,8 @@
<!--
SPDX-FileCopyrightText: hazelnoot and other Sharkey contributors
SPDX-License-Identifier: AGPL-3.0-only
Warning in the following feed/column that remote users may have incomplete/outdated activity.
-->
<template>

View file

@ -1,6 +1,8 @@
<!--
SPDX-FileCopyrightText: marie and other Sharkey contributors
SPDX-License-Identifier: AGPL-3.0-only
Displays a list of notes as results of a search.
-->
<template>

View file

@ -1,6 +1,8 @@
<!--
SPDX-FileCopyrightText: hazelnoot and other Sharkey contributors
SPDX-License-Identifier: AGPL-3.0-only
List of elements, with animations for inserting, removing, and reordering items.
-->
<template>

View file

@ -1,6 +1,8 @@
<!--
SPDX-FileCopyrightText: hazelnoot and other Sharkey contributors
SPDX-License-Identifier: AGPL-3.0-only
Displays a group of URL previews.
-->
<template>

View file

@ -1,6 +1,8 @@
<!--
SPDX-FileCopyrightText: hazelnoot and other Sharkey contributors
SPDX-License-Identifier: AGPL-3.0-only
Displays a user's recent notes for the "Following" feed.
-->
<template>