@dnb/eufemia/extensions/payment-card/PaymentCardDocs.js

DNB Eufemia Design System UI Library

export const PaymentCardProperties = {
  productCode: {
    doc: 'If product code matches one of the codes in the list the card will get that design, if no match is found Default design will be used.',
    type: 'string',
    status: 'required'
  },
  cardNumber: {
    doc: 'Masked card number.',
    type: 'string',
    status: 'required'
  },
  rawData: {
    doc: 'Useful if you want to create custom cards. See Card data properties.',
    type: 'Various',
    status: 'optional'
  },
  cardStatus: {
    doc: 'Use one of these: `active`, `notActive`, `newOrder`, `new`, `blocked`, `expired`, `renewed`, `replaced`, `orderInProcess`, `unknown`. Defaults to `active`.',
    type: ['"active"', '"notActive"', '"newOrder"', '"new"', '"blocked"', '"expired"', '"renewed"', '"replaced"', '"orderInProcess"', '"unknown"'],
    status: 'optional'
  },
  variant: {
    doc: 'Defines the appearance. Use one of these: `normal` or `compact`. Defaults to `normal`.',
    type: ['"normal"', '"compact"'],
    status: 'optional'
  },
  digits: {
    doc: 'Will use 8 digits if none are specified.',
    type: ['string', 'number'],
    status: 'optional'
  },
  locale: {
    doc: 'Use `nb-NO` or `en-GB`. Defaults to the Eufemia provider.',
    type: 'string',
    status: 'optional'
  },
  skeleton: {
    doc: 'If set to `true`, an overlaying skeleton with animation will be shown.',
    type: 'boolean',
    status: 'optional'
  },
  '[Space](/uilib/layout/space/properties)': {
    doc: 'Spacing properties like `top` or `bottom` are supported.',
    type: ['string', 'object'],
    status: 'optional'
  }
};
export const PaymentCardData = {
  productCode: {
    doc: 'Product code for the given card.',
    type: 'string',
    status: 'required'
  },
  productName: {
    doc: 'Product name. Can be blank.',
    type: 'string',
    status: 'required'
  },
  displayName: {
    doc: 'The visible product name. Can be empty.',
    type: 'string',
    status: 'required'
  },
  cardDesign: {
    doc: "Object that describes the style properties of the card. `import { Designs } from '@dnb/eufemia/extensions/payment-card'` (see available designs below) or a custom one can be created.",
    type: 'object',
    status: 'required'
  },
  cardType: {
    doc: "`import { CardType } from '@dnb/eufemia/extensions/payment-card'` to use. Can be `CardType.Visa`, `CardType.Mastercard` or `CardType.None`.",
    type: 'CardType',
    status: 'required'
  },
  productType: {
    doc: "`import { ProductType } from '@dnb/eufemia/extensions/payment-card'` to use. Can be `ProductType.Saga`, `ProductType.Pluss`, `ProductType.Intro`, `ProductType.Business`, `ProductType.Bedrift`, `ProductType.PrivateBanking`, `ProductType.Corporate`, `ProductType.WorldElite` or `ProductType.None`.",
    type: 'ProductType',
    status: 'required'
  },
  bankAxept: {
    doc: "`import { BankAxeptType } from '@dnb/eufemia/extensions/payment-card'` to use. Can be `BankAxeptType.BankAxept`, `BankAxeptType.Credit` or `BankAxeptType.None`.",
    type: 'BankAxeptType',
    status: 'required'
  }
};
export const PaymentCardDesign = {
  name: {
    doc: 'String Name of design.',
    type: 'string',
    status: 'required'
  },
  cardStyle: {
    doc: 'CSS class. Mainly to set background and color.',
    type: 'string',
    status: 'required'
  },
  bankLogo: {
    doc: "Discriminated union with `tag` property. `import { DNB } from '@dnb/eufemia/extensions/payment-card/utils/Types'`. Can be `DNB.Colored('HexValue')` or `DNB.Sbanken('HexValue')`.",
    type: 'DNB',
    status: 'required'
  },
  visa: {
    doc: "Discriminated union with `tag` property. `import { Visa } from '@dnb/eufemia/extensions/payment-card/utils/Types'`. Can be `Visa.Colored('HexValue')` or `Visa.Platinum`.",
    type: 'Visa',
    status: 'required'
  },
  mastercard: {
    doc: "Discriminated union with `tag` property. `import { Mastercard } from '@dnb/eufemia/extensions/payment-card/utils/Types'`. Can be `Mastercard.Default` or `Mastercard.Dark`.",
    type: 'Mastercard',
    status: 'required'
  },
  bankAxept: {
    doc: "Discriminated union with `tag` property. `import { BankAxept } from '@dnb/eufemia/extensions/payment-card/utils/Types'`. Can be `BankAxept.White`, `BankAxept.Black`, `BankAxept.Gold`, `BankAxept.Black20` or `BankAxept.Gray`.",
    type: 'BankAxept',
    status: 'required'
  },
  saga: {
    doc: "Discriminated union with `tag` property. `import { Saga } from '@dnb/eufemia/extensions/payment-card/utils/Types'`. Can be `Saga.Gold`, `Saga.Platinum` or `Saga.None`.",
    type: 'Saga',
    status: 'required'
  },
  privateBanking: {
    doc: "Discriminated union with `tag` property. `import { PB } from '@dnb/eufemia/extensions/payment-card/utils/Types'`. Can be `PB.Default` or `PB.None`.",
    type: 'PB',
    status: 'required'
  }
};
export const PaymentCardDesigns = {
  defaultDesign: {
    doc: 'Default',
    type: 'object',
    status: 'optional'
  },
  pluss: {
    doc: 'Pluss',
    type: 'object',
    status: 'optional'
  },
  young: {
    doc: 'Ung',
    type: 'object',
    status: 'optional'
  },
  myFirst: {
    doc: 'My first',
    type: 'object',
    status: 'optional'
  },
  youth: {
    doc: 'Youth',
    type: 'object',
    status: 'optional'
  },
  gold: {
    doc: 'Gold',
    type: 'object',
    status: 'optional'
  },
  saga: {
    doc: 'Saga',
    type: 'object',
    status: 'optional'
  },
  sagaPlatinum: {
    doc: 'Saga Platinum',
    type: 'object',
    status: 'optional'
  },
  privateBanking: {
    doc: 'Private Banking',
    type: 'object',
    status: 'optional'
  },
  mcBlack: {
    doc: 'Mastercard Black',
    type: 'object',
    status: 'optional'
  },
  businessNoVisa: {
    doc: 'Bedriftskort BankAxept',
    type: 'object',
    status: 'optional'
  },
  businessWithVisa: {
    doc: 'Bedriftskort Visa',
    type: 'object',
    status: 'optional'
  },
  sbankenVisa: {
    doc: 'Sbanken Visa',
    type: 'object',
    status: 'optional'
  },
  sbankenMastercard: {
    doc: 'Sbanken Mastercard',
    type: 'object',
    status: 'optional'
  }
};
//# sourceMappingURL=PaymentCardDocs.js.map