Gallerykit
Core

API

import { useContainerWidth, useResponsiveColumns, useSelection, useImageLoad, ExifSchema, Exif, MediaTypeSchema, MediaType } from "@gallerykit/core";

Public exports

NameKindSummary
ExifSchemaschemaZod schema for Exif.
ExifvaluePublic value.
MediaTypeSchemaschemaZod schema for MediaType.
MediaTypevaluePublic value.
ImageSourceSchemaschemaZod schema for ImageSource.
ImageSourcevaluePublic value.
GalleryItemSchemaschemaZod schema for GalleryItem.
GalleryItemvaluePublic value.
PaginationConfigSchemaschemaZod schema for PaginationConfig.
PaginationConfigtypeTypeScript type.
HoverEffectSchemaschemaZod schema for HoverEffect.
HoverEffectvaluePublic value.
ImageLoadingSchemaschemaZod schema for ImageLoading.
ImageLoadingvaluePublic value.
ResponsiveColumnsSchemaschemaZod schema for ResponsiveColumns.
ColumnsSchemaschemaZod schema for Columns.
ColumnsvaluePublic value.
DEFAULT_BREAKPOINTSvalueDefault value constant.
BreakpointsSchemaschemaZod schema for Breakpoints.
BreakpointsvaluePublic value.
AspectRatioSchemaschemaZod schema for AspectRatio.
AspectRatiovaluePublic value.
GalleryConfigSchemaschemaZod schema for GalleryConfig.
GalleryConfigtypeTypeScript type.
GridConfigSchemaschemaZod schema for GridConfig.
GridConfigtypeTypeScript type.
MasonryConfigSchemaschemaZod schema for MasonryConfig.
MasonryConfigtypeTypeScript type.
JustifiedConfigSchemaschemaZod schema for JustifiedConfig.
JustifiedConfigtypeTypeScript type.
CarouselConfigSchemaschemaZod schema for CarouselConfig.
CarouselConfigtypeTypeScript type.
CarouselEffectSchemaschemaZod schema for CarouselEffect.
LightboxInfoPositionSchemaschemaZod schema for LightboxInfoPosition.
LightboxConfigSchemaschemaZod schema for LightboxConfig.
LightboxConfigtypeTypeScript type.
PaywallConfigSchemaschemaZod schema for PaywallConfig.
PaywallConfigtypeTypeScript type.
AnimationTypeSchemaschemaZod schema for AnimationType.
PaginationTypeSchemaschemaZod schema for PaginationType.
LayoutCapabilitiesSchemaschemaZod schema for LayoutCapabilities.
LayoutCapabilitiesvaluePublic value.
LayoutDescriptionsvaluePublic value.
ColorModeSchemaschemaZod schema for ColorMode.
ColorModevaluePublic value.
SlotOverrideSchemaschemaZod schema for SlotOverride.
SlotOverridevaluePublic value.
ThemeDefinitionSchemaschemaZod schema for ThemeDefinition.
ThemeDefinitiontypeTypeScript type.
ThemeRegistryEntrySchemaschemaZod schema for ThemeRegistryEntry.
SkinSlotNameSchemaschemaZod schema for SkinSlotName.
SkinSlotNamevaluePublic value.
SkinDefinitionSchemaschemaZod schema for SkinDefinition.
SkinDefinitiontypeTypeScript type.
SocialPlatformSchemaschemaZod schema for SocialPlatform.
SocialPlatformvaluePublic value.
SocialLinkSchemaschemaZod schema for SocialLink.
SocialLinkvaluePublic value.
ImageRefSchemaschemaZod schema for ImageRef.
ImageRefvaluePublic value.
PhotographerProfileSchemaschemaZod schema for PhotographerProfile.
PhotographerProfilevaluePublic value.
AlbumVisibilitySchemaschemaZod schema for AlbumVisibility.
AlbumCategorySchemaschemaZod schema for AlbumCategory.
AlbumCategoryvaluePublic value.
AlbumSchemaschemaZod schema for Album.
AlbumvaluePublic value.
NavItemSchemaschemaZod schema for NavItem.
NavItemvaluePublic value.
LogoSchemaschemaZod schema for Logo.
LogovaluePublic value.
NavStyleSchemaschemaZod schema for NavStyle.
PortfolioNavigationSchemaschemaZod schema for PortfolioNavigation.
PortfolioNavigationvaluePublic value.
HeroLayoutSchemaschemaZod schema for HeroLayout.
HeroSchemaschemaZod schema for Hero.
HerovaluePublic value.
PortfolioSectionSchemaschemaZod schema for PortfolioSection.
PortfolioSectionvaluePublic value.
PortfolioPageSchemaschemaZod schema for PortfolioPage.
PortfolioPagevaluePublic value.
PortfolioSiteSchemaschemaZod schema for PortfolioSite.
PortfolioSitevaluePublic value.
DamRatingSchemaschemaZod schema for DamRating.
DamRatingvaluePublic value.
DamFlagSchemaschemaZod schema for DamFlag.
DamFlagvaluePublic value.
DamColorLabelSchemaschemaZod schema for DamColorLabel.
DamColorLabelvaluePublic value.
DamApprovalSchemaschemaZod schema for DamApproval.
DamApprovalvaluePublic value.
DamFileTypeSchemaschemaZod schema for DamFileType.
DamFileTypevaluePublic value.
DamExifSchemaschemaZod schema for DamExif.
DamExifvaluePublic value.
DamMediaSchemaschemaZod schema for DamMedia.
DamMediavaluePublic value.
DamThumbnailSchemaschemaZod schema for DamThumbnail.
DamThumbnailvaluePublic value.
DamItemSchemaschemaZod schema for DamItem.
DamItemvaluePublic value.
DamFolderSchemaschemaZod schema for DamFolder.
DamFoldervaluePublic value.
DamSmartRuleSchemaschemaZod schema for DamSmartRule.
DamSmartRulevaluePublic value.
DamCollectionSchemaschemaZod schema for DamCollection.
DamCollectionvaluePublic value.
DamSortFieldSchemaschemaZod schema for DamSortField.
DamSortDirSchemaschemaZod schema for DamSortDir.
DamSortSchemaschemaZod schema for DamSort.
DamSortvaluePublic value.
DamViewModeSchemaschemaZod schema for DamViewMode.
DamViewConfigSchemaschemaZod schema for DamViewConfig.
DamViewConfigtypeTypeScript type.
useContainerWidthhookHook for container width.
useResponsiveColumnshookHook for responsive columns.
useSelectionhookHook for selection.
useImageLoadhookHook for image load.
useGalleryContexthookHook for gallery context.
GalleryContextvaluePublic value.
BreakpointNamevaluePublic value.
SelectionStatevaluePublic value.
ImageLoadStatevaluePublic value.
GalleryContextValuevaluePublic value.
layoutRegistryvalueRuntime registry instance.
themeRegistryvalueRuntime registry instance.
skinRegistryvalueRuntime registry instance.
SkinItemPropstypeTypeScript type.
SkinComponentsvaluePublic value.
ThemeProvidervaluePublic value.
useThemeContexthookHook for theme context.
ThemeProviderPropstypeTypeScript type.
GalleryvalueHost component that renders a gallery from a config + items.
GalleryPropstypeTypeScript type.
getAspectRatiovaluePublic value.
groupByDatevaluePublic value.
sortItemsvaluePublic value.
computeSrcSetvaluePublic value.
computeSizesvaluePublic value.
getAspectRatioPaddingvaluePublic value.
parseAspectRatiovaluePublic value.

See the JSDoc reference for the full type signatures.

On this page