diff --git a/src/enums/descriptionPlacement.ts b/src/enums/descriptionPlacement.ts new file mode 100644 index 00000000..4d666856 --- /dev/null +++ b/src/enums/descriptionPlacement.ts @@ -0,0 +1,9 @@ +import { UnionOfConst } from '@/typeUtils.js'; + +export const DescriptionPlacement = { + ABOVE: 'above', + BELOW: 'below', +} as const; +export type DescriptionPlacementType = UnionOfConst< + typeof DescriptionPlacement +>; diff --git a/src/index.ts b/src/index.ts index 6f0a42a3..86f50cc9 100644 --- a/src/index.ts +++ b/src/index.ts @@ -100,6 +100,11 @@ export { ClientHostManager } from './hostManager/hostManager.js'; */ export * from './invitation/invitation.js'; +/** + * DescriptionPlacement enum + */ +export * from './enums/descriptionPlacement.js'; + /** * Item */ diff --git a/src/item/itemSettings.ts b/src/item/itemSettings.ts index e83b4735..fcec8893 100644 --- a/src/item/itemSettings.ts +++ b/src/item/itemSettings.ts @@ -2,6 +2,7 @@ import { CCLicenseAdaptions, OldCCLicenseAdaptations, } from '@/enums/ccLicenses.js'; +import { DescriptionPlacementType } from '@/enums/descriptionPlacement.js'; export interface ItemSettings { /** @deprecated use item.lang */ @@ -19,4 +20,5 @@ export interface ItemSettings { | CCLicenseAdaptions // TODO: these are the old licenses, we might remove them at some point. | `${OldCCLicenseAdaptations}`; + descriptionPlacement?: DescriptionPlacementType; }