LogoLogo
Home
  • Documentation
  • Developers
  • The Venue Developer Documentation
  • Next.js SDK
    • React Components
      • VenueContent
      • VenueImage
    • reference
      • Index
      • functions
        • VenueContent
        • VenueImage
        • getEvent
        • getEvents
        • getLocalizedContent
        • getPage
        • getPages
        • getProduct
        • getProducts
        • getProfile
        • getProfileEvents
        • getProfiles
        • getSite
        • setConfig
      • interfaces
        • NodeHandlers
        • NodeProps
        • RenderNode
      • type-aliases
        • ContentStyles
        • Event
        • GetEventData
        • GetEventError
        • GetEventResponse
        • GetEventsData
        • GetEventsError
        • GetEventsResponse
        • GetPageData
        • GetPageError
        • GetPageResponse
        • GetPagesData
        • GetPagesError
        • GetPagesResponse
        • GetProductData
        • GetProductError
        • GetProductResponse
        • GetProductsData
        • GetProductsError
        • GetProductsResponse
        • GetProfileData
        • GetProfileError
        • GetProfileEventsData
        • GetProfileEventsError
        • GetProfileEventsResponse
        • GetProfileResponse
        • GetProfilesData
        • GetProfilesError
        • GetProfilesResponse
        • GetSiteData
        • GetSiteError
        • GetSiteResponse
        • LocalizedContent
        • Location
        • MediaItem
        • NodeHandler
        • Page
        • Product
        • ProductVariant
        • Profile
        • Site
        • SiteSettings
        • TicketOnEvent
        • publishState
        • recordType
  • TypeScript SDK
    • reference
      • Index
      • functions
        • getEvent
        • getEvents
        • getLocalizedContent
        • getPage
        • getPages
        • getProduct
        • getProducts
        • getProfile
        • getProfileEvents
        • getProfiles
        • getSite
        • setConfig
      • type-aliases
        • Event
        • GetEventData
        • GetEventError
        • GetEventResponse
        • GetEventsData
        • GetEventsError
        • GetEventsResponse
        • GetPageData
        • GetPageError
        • GetPageResponse
        • GetPagesData
        • GetPagesError
        • GetPagesResponse
        • GetProductData
        • GetProductError
        • GetProductResponse
        • GetProductsData
        • GetProductsError
        • GetProductsResponse
        • GetProfileData
        • GetProfileError
        • GetProfileEventsData
        • GetProfileEventsError
        • GetProfileEventsResponse
        • GetProfileResponse
        • GetProfilesData
        • GetProfilesError
        • GetProfilesResponse
        • GetSiteData
        • GetSiteError
        • GetSiteResponse
        • LocalizedContent
        • Location
        • MediaItem
        • Page
        • Product
        • ProductVariant
        • Profile
        • Site
        • SiteSettings
        • TicketOnEvent
        • publishState
        • recordType
  • REST API
    • Api
      • V2
        • Public
          • Events
          • Pages
          • Products
          • Site
          • Profiles
            • Events
Powered by GitBook
On this page
Export as PDF
  1. Next.js SDK
  2. React Components

VenueImage

Last updated 4 months ago

When rendering images returned from Venue you can use this component to render a Next Image that will utilize metadata attached to the image as well as handling sizing parameter. This also includes any Image center positioning that might be set from the backend. Example:


import { VenueImage } from "@venuecms/sdk-next";

export const Event = ({ event }: { event: VenueEvent }) => {
  return (
    <div>
      <VenueImage image={event.image} className="w-full" />
    </div>
  );
}

Props:

Name
Type
Description

className?

string

Classes that wil be passed to the underlying element

image?

Partial<>

A MediaItem that is returned from Venue CMS

aspect?

'square'|'video'

Aspect for constraining the image

props?

props

Next Image props that will be passed to the underlying Next Image component

MediaItem
NextImage