@lskjs/bots-plugin-interview v2.85.1

LSK.js – bots-plugin-interview

@lskjs/bots-plugin-interview – LSK.js plugin for @lskjs/bots module for telegram, slack, discord, whatsapp, twitter, instagram and vk bots creation

Table of contents

• ⌨️ Install

• Bots Plugin Interview

  • Interview
  • Portal

• 📖 License

• 👥 Contributors

• 👏 Contributing

• 📮 Any questions? Always welcome :)

⌨️ Install

# yarn
yarn i @lskjs/bots-plugin-interview lodash

# npm
npm i @lskjs/bots-plugin-interview lodash

Bots Plugin Interview

Bots Plugin Interview (@lskjs/bots-plugin-interview) - плагин, позволяющий создавать формы ввода в боте. Реализована вариация с классической браузерной формой с подтверждением введенных данных. Режим диалога находится в стации разработки.

Конфиг для плагина состоит из двух частей - interview и portal. Interview отвечает за настройку формы, её полей и их валидацию. Portal реализует взаимодействие с формой. Например, при каких действиях пользователя будет вызвана форма.

Входные данные сохраняются в базу и хранятся в модели BotsTelegramUserModel. Путь в модели meta.interview.[formName].

Interview

Конфиг для настройки формы, её полей и их валиацию.

bot/plugins/interview/forms - обязательный путь до форм.

Params:

Example:

bots: {
  plugins: {
    interview: {
      forms: {
        intro:  {
          title: 'Добро пожаловать. Для продолжения пройдите краткую регистрацию!',
          controls: {
            name: {
              title: 'Имя',
              placeholder: 'Введите имя',
              format: String,
            },
            city: {
              title: 'Город',
              placeholder: 'Введите город',
            },
            age: {
              title: 'Возраст',
              placeholder: 'Введите ваш возраст',
              format: Number,
            },
          },
          fields: ['name', 'city', 'age'],
        },
      },
    },
  },
},

Portal

см. Bost Plugin Portal - checkInterview & replyInterview.

📖 License

This project is licensed under the MIT License - see the LICENSE file for details

👥 Contributors

👏 Contributing

1. Fork it (https://github.com/yourname/yourproject/fork)
2. Create your feature branch (git checkout -b features/fooBar)
3. Commit your changes (git commit -am 'feat(image): Add some fooBar')
4. Push to the branch (git push origin feature/fooBar)
5. Create a new Pull Request

📮 Any questions? Always welcome :)

• Email
• LSK.news – Telegram channel
• Спроси нас в телеграме ;)