All pages
Powered by GitBook
1 of 15

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

functions

VenueContent

@venuecms/sdk-next


Function: VenueContent()

function VenueContent(__namedParameters): null | Element

Defined in: sdk-next/src/components/VenueContent/index.tsx:308

Parameters

Parameter
Type

Returns

null | Element

VenueImage


Function: VenueImage()

Defined in:

__namedParameters

{ className: string; content: LocalizedContent; contentStyles: Partial<Record<string | number, string>>; }

__namedParameters.className?

string

__namedParameters.content

LocalizedContent

__namedParameters.contentStyles?

Partial<Record<string | number, string>>

Parameters
Parameter
Type

__namedParameters

{ aspect: "square" | "video"; className: string; image: Partial<>; props: object; }

__namedParameters.aspect?

"square" | "video"

__namedParameters.className?

string

__namedParameters.image?

Partial<>

__namedParameters.props?

object

Returns

null | Element

@venuecms/sdk-next
sdk-next/src/components/VenueImage/index.tsx:14

getEvents

@venuecms/sdk-next


Function: getEvents()

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

Defined in: sdk-next/src/lib/api/index.ts:37

Get a list of events (cached)

Parameters

Parameter
Type

Returns

Promise< | { data: undefined; error: unknown; } | { data: ; error: undefined; } & object>

function VenueImage(__namedParameters): null | Element

params

| undefined | { dir: "asc" | "desc"; featured: null | boolean; gt: null | number; legacyId: string; limit: null | number; lt: null | number; orderBy: string; page: null | number; tags: string | string[]; upcoming: null | boolean; }

GetEventsResponse
MediaItem
MediaItem

getEvent

@venuecms/sdk-next


Function: getEvent()

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

Defined in: sdk-next/src/lib/api/index.ts:45

Retrieve data for a single event (cached)

Parameters

Parameter
Type

Returns

Promise< | { data: undefined; error: unknown; } | { data: ; error: undefined; } & object>

params

Omit<{ siteKey: string; slug: string; }, "siteKey">

Event

getProducts

@venuecms/sdk-next


Function: getProducts()

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

Defined in: sdk-next/src/lib/api/index.ts:96

Get a listing of products (cached)

Parameters

Parameter
Type

Returns

Promise< | { data: undefined; error: unknown; } | { data: ; error: undefined; } & object>

getSite

@venuecms/sdk-next


Function: getSite()

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

Defined in: sdk-next/src/lib/api/index.ts:30

Get the site configured via the siteKey (cached)

Returns

Promise< | { data: ; error: undefined; } | { data: undefined; error: unknown; } & object>

getLocalizedContent


Function: getLocalizedContent()

Defined in:

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.

getProfiles


Function: getProfiles()

Defined in:

Get a list of profiles (cached)

getProduct


Function: getProduct()

Defined in:

Get a product (cached)

getProfile


Function: getProfile()

Defined in:

Get a profile (cached)

setConfig


Function: setConfig()

Defined in:

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.

params

| undefined | { dir: "asc" | "desc"; limit: null | number; orderBy: string; page: null | number; tags: string | string[]; type: "member"; }

GetProductsResponse
Site
Parameters
Parameter
Type

params

Omit<{ siteKey: string; slug: string; }, "siteKey">

Returns

Promise< | { data: undefined; error: unknown; } | { data: Product; error: undefined; } & object>

@venuecms/sdk-next
sdk-next/src/lib/api/index.ts:104
Parameters
Parameter
Type

params

Omit<{ siteKey: string; slug: string; }, "siteKey">

Returns

Promise< | { data: undefined; error: unknown; } | { data: Profile; error: undefined; } & object>

@venuecms/sdk-next
sdk-next/src/lib/api/index.ts:77
Parameters
Parameter
Type

params

{ options: Partial<RequestOptions>; siteKey: string; }

params.options?

Partial<RequestOptions>

params.siteKey

string

Returns

void

@venuecms/sdk-next
sdk/dist/index.d.mts:850
function getProduct(params): Promise<
  | {
  data: undefined;
  error: unknown;
 }
  | {
  data: Product;
  error: undefined;
} & object>
function getProfile(params): Promise<
  | {
  data: undefined;
  error: unknown;
 }
  | {
  data: Profile;
  error: undefined;
} & object>
function setConfig(params): void
Parameters
Parameter
Type

localizedContent

undefined | []

locale

string

Returns

object

Name
Type
Defined in

content

currentLocale

string

Example

@venuecms/sdk-next
sdk/dist/index.d.mts:828
Parameters
Parameter
Type

params

| undefined | { dir: "asc" | "desc"; limit: null | number; orderBy: string; page: null | number; tags: string

Returns

Promise< | { data: undefined; error: unknown; } | { data: GetProfilesResponse; error: undefined; } & object>

@venuecms/sdk-next
sdk-next/src/lib/api/index.ts:69

getPages

@venuecms/sdk-next


Function: getPages()

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

Defined in: sdk-next/src/lib/api/index.ts:53

Get a list of all pages (cached)

Parameters

Parameter
Type

Returns

Promise< | { data: undefined; error: unknown; } | { data: ; error: undefined; } & object>

function getLocalizedContent(localizedContent, locale): object
import { getEvent, getLocalizedContent } from "@venuecms/sdk";
import { ContentRender, type RenderNode } from "@/lib/utils/renderer";

// let's assume we are looking at an event and want to show the locale-specific title of that event in english
const { data: event } = await getEvent({ slug });

// Use getLocalizedContent to retrieve all localized content in the correct locale
// typically you will pass a locale from your app (such as from a i18n library) but
// for clarity I am passing "en" explicitly to retrieve the english version
const { content } = getLocalizedContent(event.localizedContent, "en");

// Render the content in english using the renderer
return (
  <div>
    <VenueContent classes={renderedStyles} content={content} />
  </div>
);
function getProfiles(params): Promise<
  | {
  data: undefined;
  error: unknown;
 }
  | {
  data: GetProfilesResponse;
  error: undefined;
} & object>
|
string
[];
type
:
"member"
; }

params

| undefined | { dir: "asc" | "desc"; featured: null | boolean; limit: null | number; orderBy: string; page: null | number; tags: string | string[]; }

GetPagesResponse
LocalizedContent
LocalizedContent
sdk/dist/index.d.mts:829
sdk/dist/index.d.mts:830

getProfileEvents

@venuecms/sdk-next


Function: getProfileEvents()

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

Defined in: sdk-next/src/lib/api/index.ts:85

Get a listing of events for a profile (cached)

Parameters

Parameter
Type

Returns

Promise< | { data: undefined; error: unknown; } | { data: ; error: undefined; } & object>

params

Omit<{ siteKey: string; slug: string; }, "siteKey"> & object

GetProfileEventsResponse

getPage

@venuecms/sdk-next


Function: getPage()

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

Defined in: sdk-next/src/lib/api/index.ts:61

Get a single page using the slug (cached)

Parameters

Parameter
Type

Returns

Promise< | { data: undefined; error: unknown; } | { data: ; error: undefined; } & object>

params

Omit<{ siteKey: string; slug: string; }, "siteKey">

GetPageResponse