clawrock/magento2-faq

Module allows you to add questions and answers for FAQ.

dev-master 2023-01-17 18:22 UTC

Requires

• magento/framework: ~103.0
• magento/module-backend: ~102.0
• magento/module-widget: ~101.2

Requires (Dev)

• bitexpert/phpstan-magento: ^0.27.0
• dealerdirect/phpcodesniffer-composer-installer: ^0.7.1
• magento/magento-coding-standard: *
• phpcompatibility/php-compatibility: ^9.3
• phpmd/phpmd: ^2.9.1
• phpstan/phpstan: ~1.9.0
• phpstan/phpstan-phpunit: ^1.1.1
• phpunit/phpunit: ~9.5.0
• sebastian/phpcpd: ^6.0.3
• slevomat/coding-standard: ~6.4.1
• squizlabs/php_codesniffer: ~3.6.0

OSL-3.0, AFL-3.0

README

Magento 2 module, that allows you to create custom FAQ question & answers, place single and list of questions in CMS pages as widget. They can be filtered by category or searched by question.

Compatibility

• Magento 2.4
• PHP 7.4, 8.1

Installation

1. composer require clawrock/magento2-faq
2. php bin/magento setup:upgrade

Configuration

1. Go to Stores -> Configuration -> General -> FAQ
2. Set default question limit displayed per page when display all questions using widget

Widgets

You can add questions using widgets. There are three types of widgets:

1. Question list - display list of selected questions & answers
2. Question - display single question & answer
3. Faq - display all questions & answers with limit per page.

Tests

To run test run from console: vendor/bin/phpunit -c phpunit.xml.dist