Skip to content

Commit

Permalink
feat: add descriptionPlacement in itemSettings (#431)
Browse files Browse the repository at this point in the history
  • Loading branch information
ReidyT authored Mar 4, 2024
1 parent 2a5cfd5 commit c3334d8
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 0 deletions.
9 changes: 9 additions & 0 deletions src/enums/descriptionPlacement.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import { UnionOfConst } from '@/typeUtils.js';

export const DescriptionPlacement = {
ABOVE: 'above',
BELOW: 'below',
} as const;
export type DescriptionPlacementType = UnionOfConst<
typeof DescriptionPlacement
>;
5 changes: 5 additions & 0 deletions src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,11 @@ export { ClientHostManager } from './hostManager/hostManager.js';
*/
export * from './invitation/invitation.js';

/**
* DescriptionPlacement enum
*/
export * from './enums/descriptionPlacement.js';

/**
* Item
*/
Expand Down
2 changes: 2 additions & 0 deletions src/item/itemSettings.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import {
CCLicenseAdaptions,
OldCCLicenseAdaptations,
} from '@/enums/ccLicenses.js';
import { DescriptionPlacementType } from '@/enums/descriptionPlacement.js';

export interface ItemSettings {
/** @deprecated use item.lang */
Expand All @@ -19,4 +20,5 @@ export interface ItemSettings {
| CCLicenseAdaptions
// TODO: these are the old licenses, we might remove them at some point.
| `${OldCCLicenseAdaptations}`;
descriptionPlacement?: DescriptionPlacementType;
}

0 comments on commit c3334d8

Please sign in to comment.