umbot - v2.0.8
    Preparing search index...

    Class VkCard

    VkCard Класс для создания и отображения карточек в ВКонтакте. Наследуется от TemplateCardTypes и реализует специфичную для ВКонтакте логику.

    Основные возможности:

    • Создание карусели с карточками
    • Создание галереи изображений
    • Поддержка кнопок (до 3 кнопок на карточку)
    • Автоматическая загрузка изображений в ВКонтакте
    • Поддержка различных типов действий
    • Ограничение длины текста
    • Форматирование описаний
    // Создание карусели с товарами
    const card = new VkCard();
    card.title = 'Каталог товаров';
    card.images = [
        new Image('product1.jpg', 'Товар 1', 'Описание 1'),
        new Image('product2.jpg', 'Товар 2', 'Описание 2')
    ];
    const carousel = await card.getCard(false);

    // Создание галереи фотографий
    const galleryCard = new VkCard();
    galleryCard.isUsedGallery = true;
    galleryCard.images = [
        new Image('photo1.jpg', 'Фото 1', 'Описание 1'),
        new Image('photo2.jpg', 'Фото 2', 'Описание 2')
    ];
    const gallery = await galleryCard.getCard(false);

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    images button title isUsedGallery

    Methods

    getCard

    Constructors

    Properties

    images: Image[]

    Массив изображений или элементов для карточки. Каждый элемент может содержать изображение, заголовок, описание и кнопки.

    Image

    this.images = [
        new Image('image1.jpg', 'Заголовок 1', 'Описание 1'),
        new Image('image2.jpg', 'Заголовок 2', 'Описание 2')
    ];
    button: Buttons

    Кнопки для карточки. Используются для взаимодействия с пользователем.

    Buttons

    this.button.addBtn('Купить');
    this.button.addLink('Подробнее', 'https://example.com');
    title: null | string

    Заголовок карточки. Отображается в верхней части карточки.

    this.title = 'Название товара';
    isUsedGallery: boolean = false

    Флаг использования галереи изображений. true - изображения отображаются в виде галереи false - изображения отображаются как отдельные карточки

    this.isUsedGallery = true; // Включить режим галереи

    Methods

    • Получает карточку для отображения в ВКонтакте.

      Процесс работы:

      1. Проверяет количество изображений
      2. Если isOne=true или одно изображение:
        • Загружает изображение в ВКонтакте
        • Возвращает массив с ID изображения
      3. Иначе:
        • Создает карусель или галерею
        • Загружает все изображения
        • Добавляет кнопки (до 3 на карточку)
        • Форматирует текст (заголовок и описание)

      Parameters

      • isOne: boolean

        Флаг отображения только одного элемента

      Returns Promise<string[] | IVkCard>

      Карточка или массив ID изображений

      const card = new VkCard();
      card.images = [
          new Image('product1.jpg', 'Товар 1', 'Описание 1'),
          new Image('product2.jpg', 'Товар 2', 'Описание 2')
      ];

      // Получить одну карточку
      const singleCard = await card.getCard(true);
      // singleCard = ['123456789']

      // Получить карусель
      const carousel = await card.getCard(false);
      // carousel = {
      //     type: 'carousel',
      //     elements: [
      //         { title: 'Товар 1', description: 'Описание 1', photo_id: '123456789' },
      //         { title: 'Товар 2', description: 'Описание 2', photo_id: '987654321' }
      //     ]
      // }

      // Получить галерею
      card.isUsedGallery = true;
      const gallery = await card.getCard(false);
      // gallery = {
      //     type: 'gallery',
      //     elements: [
      //         { title: 'Товар 1', description: 'Описание 1', photo_id: '123456789' },
      //         { title: 'Товар 2', description: 'Описание 2', photo_id: '987654321' }
      //     ]
      // }

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods