Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
function VenueContent(__namedParameters): null | ElementDefined in: sdk-next/src/components/VenueContent/index.tsx:308
null | Element
__namedParameters
{ className: string; content: LocalizedContent; contentStyles: Partial<Record<string | number, string>>; }
__namedParameters.className?
string
__namedParameters.content
__namedParameters.contentStyles?
Partial<Record<string | number, string>>
__namedParameters
{ aspect: "square" | "video"; className: string; image: Partial<>; props: object; }
__namedParameters.aspect?
"square" | "video"
__namedParameters.className?
string
__namedParameters.image?
Partial<>
__namedParameters.props?
object
null | Element
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)
Promise< | { data: undefined; error: unknown; } | { data: ; error: undefined; } & object>
function VenueImage(__namedParameters): null | Elementparams
| 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; }
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)
Promise< | { data: undefined; error: unknown; } | { data: ; error: undefined; } & object>
params
Omit<{ siteKey: string; slug: string; }, "siteKey">
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)
Promise< | { data: undefined; error: unknown; } | { data: ; error: undefined; } & object>
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)
Promise< | { data: ; error: undefined; } | { data: undefined; error: unknown; } & object>
params
| undefined | { dir: "asc" | "desc"; limit: null | number; orderBy: string; page: null | number; tags: string | string[]; type: "member"; }
params
Omit<{ siteKey: string; slug: string; }, "siteKey">
Promise< | { data: undefined; error: unknown; } | { data: Product; error: undefined; } & object>
params
Omit<{ siteKey: string; slug: string; }, "siteKey">
Promise< | { data: undefined; error: unknown; } | { data: Profile; error: undefined; } & object>
params
{ options: Partial<RequestOptions>; siteKey: string; }
params.options?
Partial<RequestOptions>
params.siteKey
string
void
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): voidlocalizedContent
undefined | []
locale
string
object
content
currentLocale
string
params
| undefined | { dir: "asc" | "desc"; limit: null | number; orderBy: string; page: null | number; tags: string
Promise< | { data: undefined; error: unknown; } | { data: GetProfilesResponse; error: undefined; } & object>
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)
Promise< | { data: undefined; error: unknown; } | { data: ; error: undefined; } & object>
function getLocalizedContent(localizedContent, locale): objectimport { 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>stringtype"member"params
| undefined | { dir: "asc" | "desc"; featured: null | boolean; limit: null | number; orderBy: string; page: null | number; tags: string | string[]; }
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)
Promise< | { data: undefined; error: unknown; } | { data: ; error: undefined; } & object>
params
Omit<{ siteKey: string; slug: string; }, "siteKey"> & object
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)
Promise< | { data: undefined; error: unknown; } | { data: ; error: undefined; } & object>
params
Omit<{ siteKey: string; slug: string; }, "siteKey">