Backup_Repos/stash
1
0
Fork 0
mirror of https://github.com/stashapp/stash.git synced 2025-12-06 16:34:02 +01:00
Code Issues Projects Releases Wiki Activity

Organize UIPluginApi.md docs and pluginApi.d.ts (#5971)

Browse source 
* Organized alphabetically and removed duplicate Setting and TabTitleCounter
* Organized components alphabetically
* Add missing PerformerDetailsPanel and PerformerDetailsPanel.DetailGroup
* Add missing SceneFileInfoPanel component
* Add missing MainNavBar.MenuItems and MainNavBar.UtilityItems in docs
This commit is contained in:
QxxxGit 2025-06-30 23:48:16 -04:00 committed by GitHub
parent 3a232b1d6c
commit f01f95ddfb
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 86 additions and 83 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
ui/v2.5/src/docs/en/Manual/UIPluginApi.md
View file

@ -153,8 +153,8 @@ Returns `void`.
- `CompressedPerformerDetailsPanel` - `CompressedPerformerDetailsPanel`
- `ConstantSetting` - `ConstantSetting`
- `CountrySelect` - `CountrySelect`
- `CustomFields`
- `CustomFieldInput` - `CustomFieldInput`
- `CustomFields`
- `DateInput` - `DateInput`
- `DetailImage` - `DetailImage`
- `ExternalLinkButtons` - `ExternalLinkButtons`
@ -169,6 +169,9 @@ Returns `void`.
- `GalleryIDSelect` - `GalleryIDSelect`
- `GallerySelect` - `GallerySelect`
- `GallerySelect.sort` - `GallerySelect.sort`
- `GroupIDSelect`
- `GroupSelect`
- `GroupSelect.sort`
- `HeaderImage` - `HeaderImage`
- `HoverPopover` - `HoverPopover`
- `Icon` - `Icon`
@ -176,10 +179,9 @@ Returns `void`.
- `ImageInput` - `ImageInput`
- `LightboxLink` - `LightboxLink`
- `LoadingIndicator` - `LoadingIndicator`
- `MainNavBar.MenuItems`
- `MainNavBar.UtilityItems`
- `ModalSetting` - `ModalSetting`
- `GroupIDSelect`
- `GroupSelect`
- `GroupSelect.sort`
- `NumberSetting` - `NumberSetting`
- `Pagination` - `Pagination`
- `PaginationIndex` - `PaginationIndex`
@ -192,16 +194,17 @@ Returns `void`.
- `PerformerCard.Title` - `PerformerCard.Title`
- `PerformerDetailsPanel` - `PerformerDetailsPanel`
- `PerformerDetailsPanel.DetailGroup` - `PerformerDetailsPanel.DetailGroup`
- `PerformerIDSelect`
- `PerformerPage`
- `PerformerSelect`
- `PerformerSelect.sort`
- `PerformerGalleriesPanel` - `PerformerGalleriesPanel`
- `PerformerGroupsPanel` - `PerformerGroupsPanel`
- `PerformerHeaderImage` - `PerformerHeaderImage`
- `PerformerIDSelect`
- `PerformerImagesPanel` - `PerformerImagesPanel`
- `PerformerPage`
- `PerformerScenesPanel` - `PerformerScenesPanel`
- `PerformerSelect`
- `PerformerSelect.sort`
- `PluginRoutes` - `PluginRoutes`
- `PluginSettings`
- `RatingNumber` - `RatingNumber`
- `RatingStars` - `RatingStars`
- `RatingSystem` - `RatingSystem`
@ -210,18 +213,20 @@ Returns `void`.
- `SceneCard.Image` - `SceneCard.Image`
- `SceneCard.Overlays` - `SceneCard.Overlays`
- `SceneCard.Popovers` - `SceneCard.Popovers`
- `SceneFileInfoPanel`
- `SceneIDSelect` - `SceneIDSelect`
- `ScenePage` - `ScenePage`
- `ScenePage.Tabs`
- `ScenePage.TabContent` - `ScenePage.TabContent`
- `ScenePage.Tabs`
- `ScenePlayer` - `ScenePlayer`
- `SceneSelect` - `SceneSelect`
- `SceneSelect.sort` - `SceneSelect.sort`
- `SelectSetting` - `SelectSetting`
- `Setting` - `Setting`
- `SettingGroup`
- `SettingModal` - `SettingModal`
- `StringSetting`
- `StringListSetting` - `StringListSetting`
- `StringSetting`
- `StudioIDSelect` - `StudioIDSelect`
- `StudioSelect` - `StudioSelect`
- `StudioSelect.sort` - `StudioSelect.sort`
@ -233,15 +238,11 @@ Returns `void`.
- `TagCard.Overlays` - `TagCard.Overlays`
- `TagCard.Popovers` - `TagCard.Popovers`
- `TagCard.Title` - `TagCard.Title`
- `TagLink`
- `TabTitleCounter`
- `TagIDSelect` - `TagIDSelect`
- `TagLink`
- `TagSelect` - `TagSelect`
- `TagSelect.sort` - `TagSelect.sort`
- `TruncatedText` - `TruncatedText`
- `PluginSettings`
- `Setting`
- `SettingGroup`
### `PluginApi.Event` ### `PluginApi.Event`

138
ui/v2.5/src/pluginApi.d.ts vendored
View file

@ -652,88 +652,90 @@ declare namespace PluginApi {
}>; }>;
} }
const components: { const components: {
HoverPopover: React.FC<any>; AlertModal: React.FC<any>;
TagLink: React.FC<any>; BackgroundImage: React.FC<any>;
LoadingIndicator: React.FC<any>;
Icon: React.FC<any>;
"MainNavBar.MenuItems": React.FC<any>;
"MainNavBar.UtilityItems": React.FC<any>;
PerformerSelect: React.FC<any>;
PerformerIDSelect: React.FC<any>;
TagSelect: React.FC<any>;
TagIDSelect: React.FC<any>;
StudioSelect: React.FC<any>;
StudioIDSelect: React.FC<any>;
GallerySelect: React.FC<any>;
GalleryIDSelect: React.FC<any>;
GroupSelect: React.FC<any>;
GroupIDSelect: React.FC<any>;
SceneSelect: React.FC<any>;
SceneIDSelect: React.FC<any>;
DateInput: React.FC<any>;
CountrySelect: React.FC<any>;
FolderSelect: React.FC<any>;
"SceneCard.Popovers": React.FC<any>;
"SceneCard.Details": React.FC<any>;
"SceneCard.Overlays": React.FC<any>;
"SceneCard.Image": React.FC<any>;
PluginSettings: React.FC<any>;
Setting: React.FC<any>;
SettingGroup: React.FC<any>;
BooleanSetting: React.FC<any>; BooleanSetting: React.FC<any>;
SelectSetting: React.FC<any>;
ChangeButtonSetting: React.FC<any>; ChangeButtonSetting: React.FC<any>;
SettingModal: React.FC<any>;
ModalSetting: React.FC<any>;
StringSetting: React.FC<any>;
NumberSetting: React.FC<any>;
StringListSetting: React.FC<any>;
ConstantSetting: React.FC<any>; ConstantSetting: React.FC<any>;
SceneFileInfoPanel: React.FC<any>; CountrySelect: React.FC<any>;
PerformerPage: React.FC<any>; CustomFieldInput: React.FC<any>;
PerformerAppearsWithPanel: React.FC<any>; CustomFields: React.FC<any>;
PerformerGalleriesPanel: React.FC<any>; DateInput: React.FC<any>;
PerformerGroupsPanel: React.FC<any>; DetailImage: React.FC<any>;
PerformerHeaderImage: React.FC<any>;
PerformerScenesPanel: React.FC<any>;
PerformerImagesPanel: React.FC<any>;
TabTitleCounter: React.FC<any>;
PerformerCard: React.FC<any>;
ExternalLinkButtons: React.FC<any>; ExternalLinkButtons: React.FC<any>;
ExternalLinksButton: React.FC<any>; ExternalLinksButton: React.FC<any>;
CustomFields: React.FC<any>; FolderSelect: React.FC<any>;
CustomFieldInput: React.FC<any>;
ImageInput: React.FC<any>;
DetailImage: React.FC<any>;
HeaderImage: React.FC<any>;
LightboxLink: React.FC<any>;
"PerformerCard.Popovers": React.FC<any>;
"PerformerCard.Details": React.FC<any>;
"PerformerCard.Overlays": React.FC<any>;
"PerformerCard.Image": React.FC<any>;
"PerformerCard.Title": React.FC<any>;
"TagCard.Popovers": React.FC<any>;
"TagCard.Details": React.FC<any>;
"TagCard.Overlays": React.FC<any>;
"TagCard.Image": React.FC<any>;
"TagCard.Title": React.FC<any>;
ScenePage: React.FC<any>;
"ScenePage.Tabs": React.FC<any>;
"ScenePage.TabContent": React.FC<any>;
ScenePlayer: React.FC<any>;
FrontPage: React.FC<any>; FrontPage: React.FC<any>;
GalleryCard: React.FC<any>; GalleryCard: React.FC<any>;
"GalleryCard.Details": React.FC<any>; "GalleryCard.Details": React.FC<any>;
"GalleryCard.Image": React.FC<any>; "GalleryCard.Image": React.FC<any>;
"GalleryCard.Overlays": React.FC<any>; "GalleryCard.Overlays": React.FC<any>;
"GalleryCard.Popovers": React.FC<any>; "GalleryCard.Popovers": React.FC<any>;
TruncatedText: React.FC<any>; GalleryIDSelect: React.FC<any>;
SweatDrops: React.FC<any>; GallerySelect: React.FC<any>;
AlertModal: React.FC<any>; GroupIDSelect: React.FC<any>;
BackgroundImage: React.FC<any>; GroupSelect: React.FC<any>;
HeaderImage: React.FC<any>;
HoverPopover: React.FC<any>;
Icon: React.FC<any>;
ImageInput: React.FC<any>;
LightboxLink: React.FC<any>;
LoadingIndicator: React.FC<any>;
"MainNavBar.MenuItems": React.FC<any>;
"MainNavBar.UtilityItems": React.FC<any>;
ModalSetting: React.FC<any>;
NumberSetting: React.FC<any>;
PerformerAppearsWithPanel: React.FC<any>;
PerformerCard: React.FC<any>;
"PerformerCard.Details": React.FC<any>;
"PerformerCard.Image": React.FC<any>;
"PerformerCard.Overlays": React.FC<any>;
"PerformerCard.Popovers": React.FC<any>;
"PerformerCard.Title": React.FC<any>;
PerformerDetailsPanel: React.FC<any>;
"PerformerDetailsPanel.DetailGroup": React.FC<any>;
PerformerGalleriesPanel: React.FC<any>;
PerformerGroupsPanel: React.FC<any>;
PerformerHeaderImage: React.FC<any>;
PerformerIDSelect: React.FC<any>;
PerformerImagesPanel: React.FC<any>;
PerformerPage: React.FC<any>;
PerformerScenesPanel: React.FC<any>;
PerformerSelect: React.FC<any>;
PluginSettings: React.FC<any>;
RatingNumber: React.FC<any>; RatingNumber: React.FC<any>;
RatingStars: React.FC<any>; RatingStars: React.FC<any>;
RatingSystem: React.FC<any>; RatingSystem: React.FC<any>;
SceneFileInfoPanel: React.FC<any>;
SceneIDSelect: React.FC<any>;
ScenePage: React.FC<any>;
"ScenePage.TabContent": React.FC<any>;
"ScenePage.Tabs": React.FC<any>;
ScenePlayer: React.FC<any>;
SceneSelect: React.FC<any>;
"SceneCard.Details": React.FC<any>;
"SceneCard.Image": React.FC<any>;
"SceneCard.Overlays": React.FC<any>;
"SceneCard.Popovers": React.FC<any>;
SelectSetting: React.FC<any>;
Setting: React.FC<any>;
SettingGroup: React.FC<any>;
SettingModal: React.FC<any>;
StringListSetting: React.FC<any>;
StringSetting: React.FC<any>;
StudioIDSelect: React.FC<any>;
StudioSelect: React.FC<any>;
SweatDrops: React.FC<any>;
TabTitleCounter: React.FC<any>;
TagIDSelect: React.FC<any>;
"TagCard.Details": React.FC<any>;
"TagCard.Image": React.FC<any>;
"TagCard.Overlays": React.FC<any>;
"TagCard.Popovers": React.FC<any>;
"TagCard.Title": React.FC<any>;
TagLink: React.FC<any>;
TagSelect: React.FC<any>;
TruncatedText: React.FC<any>;
}; };
type PatchableComponentNames = keyof typeof components | string; type PatchableComponentNames = keyof typeof components | string;
namespace utils { namespace utils {