@cross-nft-marketplace/auction-house-nft-components
Version:
NFT Media Rendering Components
152 lines (151 loc) • 4.08 kB
TypeScript
export declare const ThemeOptions: {
/**
* Overall preview card settings (width height and background)
* @default {width: '330px', height: '330px', background: 'transparent'}
*/
previewCard: {
width: string;
height: string;
background: string;
};
nftProposalCard: {
mediaWidth: string;
mediaHeight: string;
};
/**
* Flag if showing the nft creator on full view
* should be enabled
* @default true
*/
showArtist: boolean;
/**
* Flag if ens resolution should be automatically used
* @default true
*/
useEnsResolution: boolean;
/**
* Set an overriding preferred IPFS provider here
* Include a trailing slash
*/
preferredIPFSGateway: string;
/**
* Flag if zora username resolution should be automatically used
* @default true
*/
useZoraUsernameResolution: boolean;
showUserName: boolean;
/**
* Flag if showing the nft owner on full view
* should be enabled
* @default true
*/
showOwner: boolean;
/**
* Flag if showing transaction history links on full view
* should be enabled
* @default true
*/
showTxnLinks: boolean;
/**
* Padding for preview card text block
* @default 20px
*/
spacingUnit: string;
/**
* Padding for preview card text block
* @default 10px 15px
*/
textBlockPadding: string;
/**
* Border style for preview card text block
* @default 2px solid #e6e6e6
*/
borderStyle: string;
/**
* Line-spacing on preview component
* @default 24
*/
lineSpacing: number;
/**
* Maximum number of decimal digits to show
* for pricing information
* @default 8
*/
maximumPricingDecimals: number;
/**
* Color for link on full preview page authenticity link
* @default #000
*/
linkColor: string;
/**
* Settings for body text font
* @default font-family: Inter, Helvetica; font-weight: 400;
*/
bodyFont: string;
/**
* Settings for title font
* Type is parsed as a css string.
* @default font-family: Inter, Helvetica; font-weight: 500;
*/
titleFont: string;
/**
* Settings for header font
* Type is parsed as a css string.
* @default font-family: Inter, Helvetica; font-weight: 500;
*/
headerFont: string;
/**
* Font to use when rendering text NFTs
* @default {fontFamily: "Times New Roman"}
*/
mediaContentFont: {
fontFamily: string;
};
/**
* Button color configurations
* @default {primaryBackground: '#333', primaryText: '#fff', background: '#eee'}
*/
buttonColor: {
primaryBackground: string;
primaryText: string;
background: string;
text: string;
};
/**
* Border radius to use around preview card
* @default 4
*/
defaultBorderRadius: number;
/**
* Font size base for full view page
* @default 16
*/
fontSizeFull: number;
/**
* Audio Player Color configurations
* @default {waveformColor: '#999, progressColor: '#333'}
*/
audioColors: {
waveformColor: string;
progressColor: string;
};
/**
* Background color for loading media content
* @default {placeHolderColor '#e6e6e6'}
*/
placeHolderColor: string;
/**
* Max preview media size in bytes for nft preview
* @default {maxPreviewMediaSizeInBytes 5_000_000}
*/
maxPreviewMediaSize: number;
/**
* Sorted by priority from highest priority to lowest.
* @default {cdnHostsSortedByPriority [
* "googleusercontent.com",
* "seadn.io"//possible dedicaded in opensea
* ]}
*/
cdnHosts: string[];
};
export declare type ThemeOptionsType = typeof ThemeOptions;