Function: VenueContent()

function VenueContent(__namedParameters): null | Element

Parameters

Returns

null | Element

Welcome to the Venue Developer Documentation.

You can find references for the Venue SDK's here on the left-side table of contents.

Function: getEvent()

function getEvent(params): Promise<
  | {
  data: undefined;
  error: unknown;
 }
  | {
  data: Event;
  error: undefined;
} & object>

Retrieve data for a single event

Parameters

Returns

Example

import { getEvent } from "@venuecms/sdk";
import { ContentRender, type RenderNode } from "@/lib/utils/renderer";

const { data: event } = await getEvent({ slug });

// If the event is not found, you should do something like a 404
if (!event) {
  notFound();
}
const { localizedContent, location, artists } = event;

// Get the content in a localized form (usually locale is pulled from somewhere like your url params)
const { content } = getLocalizedContent(event.localizedContent, locale);

// Render content for the event
return (
  <div>
    <VenueContent classes={renderedStyles} content={content} />
  </div>
);

@venuecms/sdk-next

@venuecms/sdk-next

Configuration

Sites

Events

Pages

Profiles

Products

Utilities

Other

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:

Function: VenueImage()

function VenueImage(__namedParameters): null | Element

Parameters

Returns

null | Element

This library contains a small collection of components that are useful for rendering content from Venue CMS in a Next.js project. It also includes the Venue CMS SDK as well so there is no need to separately install that.

To install run this in your CLI under the project root:

For more information on fetching data see the reference for @venuecms/sdk

Allows you render content returned from Venue CMS in a headless way. All styles will need to be defined by you in a separate object as the renderer won't add styles by default.

Example:

Function: getEvents()

function getEvents(params?): Promise<
  | {
  data: undefined;
  error: unknown;
 }
  | {
  data: GetEventsResponse;
  error: undefined;
} & object>

Parameters

Returns

Function: getLocalizedContent()

This function will properly resolve content blocks that are localized. It takes in the array of localized content and returns the proper content to be used in your page.

Parameters

Returns

object

Example

Function: getProducts()

function getProducts(params): Promise<
  | {
  data: undefined;
  error: unknown;
 }
  | {
  data: GetProductsResponse;
  error: undefined;
} & object>

Get a listing of products

Parameters

Returns

Function: getPages()

function getPages(params?): Promise<
  | {
  data: undefined;
  error: unknown;
 }
  | {
  data: GetPagesResponse;
  error: undefined;
} & object>

Get a list of all pages

Parameters

Returns

Function: getPage()

function getPage(params): Promise<
  | {
  data: undefined;
  error: unknown;
 }
  | {
  data: GetPageResponse;
  error: undefined;
} & object>

Get a single page using the slug

Parameters

Returns

Function: setConfig()

function setConfig(params): void

Allows you to pass in the siteKey and API key manually in case you want it to be dynamically set. If you don't use this function, the SDK will default to using process.env.VENUE_SITE_KEY and process.env.VENUE_API_KEY instead.

Parameters

Returns

void

Interface: NodeHandlers

Indexable

[attr: string]: NodeHandler

Function: getProduct()

function getProduct(params): Promise<
  | {
  data: undefined;
  error: unknown;
 }
  | {
  data: Product;
  error: undefined;
} & object>

Get a product

Parameters

Returns

Function: getProfile()

function getProfile(params): Promise<
  | {
  data: undefined;
  error: unknown;
 }
  | {
  data: Profile;
  error: undefined;
} & object>

Get a profile

Parameters

Returns

Function: getProfiles()

function getProfiles(params?): Promise<
  | {
  data: undefined;
  error: unknown;
 }
  | {
  data: GetProfilesResponse;
  error: undefined;
} & object>

Get a list of profiles

Parameters

Returns

Function: getProfileEvents()

function getProfileEvents(params): Promise<
  | {
  data: undefined;
  error: unknown;
 }
  | {
  data: GetProfileEventsResponse;
  error: undefined;
} & object>

Get a listing of events for a profile

Parameters

Returns

Interface: NodeProps

Properties

Interface: RenderNode

Indexable

[attr: string]: any

Properties

Function: getSite()

function getSite(): Promise<
  | {
  data: Site;
  error: undefined;
 }
  | {
  data: undefined;
  error: unknown;
} & object>

Get the site configured via the siteKey

Returns

Type Alias: ContentStyles

type ContentStyles = Partial<Record<keyof ReturnType<typeof getDefaultHandlers>, string>>;

Type Alias: Event

type Event = object;

Type declaration

Type Alias: GetEventsError

type GetEventsError = unknown;

Type Alias: GetEventResponse

type GetEventResponse = Event;

Type Alias: GetEventError

type GetEventError = unknown;

Type Alias: GetEventData

type GetEventData = object;

Type declaration

Type Alias: GetEventsData

type GetEventsData = object;

Type declaration

Type Alias: GetEventsResponse

type GetEventsResponse = object;

Type declaration

Type Alias: GetPageData

type GetPageData = object;

Type declaration

Type Alias: GetPagesData

type GetPagesData = object;

Type declaration

Type Alias: GetPageResponse

type GetPageResponse = Page & object;

Type declaration

Type Alias: GetPagesError

type GetPagesError = unknown;

Type Alias: GetProductData

type GetProductData = object;

Type declaration

Type Alias: GetPagesResponse

type GetPagesResponse = object;

Type declaration

Type Alias: GetPageError

type GetPageError = unknown;

Type Alias: GetProductResponse

type GetProductResponse = Product;

Type Alias: GetProductsData

type GetProductsData = object;

Type declaration

Type Alias: GetProductError

type GetProductError = unknown;

Type Alias: GetProductsError

type GetProductsError = unknown;

Type Alias: GetProductsResponse

type GetProductsResponse = object;

Type declaration

Type Alias: GetProfileError

type GetProfileError = unknown;

Type Alias: GetProfileData

type GetProfileData = object;

Type declaration

Type Alias: GetProfileEventsError

type GetProfileEventsError = unknown;

Type Alias: GetProfileEventsData

type GetProfileEventsData = object;

Type declaration

Type Alias: GetProfileResponse

type GetProfileResponse = Profile;

Type Alias: GetProfileEventsResponse

Type declaration

Type Alias: GetProfilesError

type GetProfilesError = unknown;

Type Alias: GetSiteData

type GetSiteData = object;

Type declaration

Type Alias: GetProfilesResponse

type GetProfilesResponse = object;

Type declaration

Type Alias: GetSiteResponse

type GetSiteResponse = Site;

Type Alias: GetSiteError

Type Alias: LocalizedContent

type LocalizedContent = object;

Type declaration

Type Alias: GetProfilesData

Type declaration

Type Alias: Location

type Location = object;

Type declaration

Type Alias: MediaItem

type MediaItem = object;

Type declaration

Type Alias: NodeHandler()

Parameters

Returns

JSX.Element

Type Alias: Product

Type declaration

Type Alias: ProductVariant

Type declaration

Type Alias: Page

Type declaration