Add useLightbox and useGalleryLightbox in plugin api

[QxxxGit]

Adds useLightbox and useGalleryLightbox hooks to the plugin api. Also added to docs.

Tested with my gallery card plugin.

[QxxxGit]

Through further testing, I'm noticing a bug with my plugin and I'm not certain if it's related to this PR but I wanted to mention it just in case I've missed something.

When I navigate to the gallery from the card, then hit back, then try to use the gallery lightbox, I get a blank page with some errors in the console.

Starts with

TypeError: r is undefined
    to http://localhost:9996/assets/Lightbox-5bdc230c.js:1

then a couple errors of

Error: [React Intl] Could not find required `intl` object. <IntlProvider> needs to exist in the component ancestry.

My plugin code:

import { components, libraries, React, hooks } from "../globals";
import IGalleryCardProps from "../types/IGalleryCardProps";

const GalleryCardImage: React.FC<{
	props: IGalleryCardProps;
}> = ({ props }) => {
	const { Icon } = components;
	const { faMagnifyingGlass } = libraries.FontAwesomeSolid;
	const [isHovered, setIsHovered] = React.useState(false);
	const { useGalleryLightbox } = hooks;
	const showLightbox = useGalleryLightbox(props.gallery.id, []);

	const openLightbox = async (e: React.MouseEvent) => {
		if (props.gallery.image_count === 0) return;
		e.stopPropagation();
		e.preventDefault();

		showLightbox(0);
	};

	return (
		<div
			className="gallery-card-cover"
			onMouseEnter={() => setIsHovered(true)}
			onMouseLeave={() => setIsHovered(false)}>
			<img
				src={props.gallery.paths?.cover}
				className="gallery-card-image"
			/>
			<div className={`overlay ${isHovered ? "show" : ""}`}>
				<div className="button" onClick={openLightbox}>
					<Icon icon={faMagnifyingGlass} className="icon" />
				</div>
			</div>
		</div>
	);
};

export default GalleryCardImage;

[DogmaDragon]

Documentation included.

[WithoutPants]

@QxxxGit I think I'll need more of the plugin files to test this. I haven't been able to create a working plugin using the code fragment above.

[WithoutPants]

I managed to get it working to the point where I could see the magnifying glass button and could bring up the lightbox. Running a quick test as described, I wasn't able to reproduce the issue. It does sound very similar to the issue reported here, and I'm wondering if it's related to another plugin. Have you disabled all other plugins?

[WithoutPants]

The issue you describe is already reported in #5824 so should be unrelated to this change.