README

Magento 2 FAQ

This module adds an easy and efficient way to integrate a comprehensive FAQ section into your Magento store using a jQuery Accordion layout. It allows the admin to create and manage FAQs and organize them into groups, each with its own icon for better visual distinction. With a rich WYSIWYG editor, admins can enhance FAQ answers by adding widgets, static blocks, images, and more. The module streamlines customer support by making key information easily accessible in a user-friendly and interactive format.

✨ Features

Display all FAQs or FAQs by group on CMS pages and static blocks
Enable AJAX-based FAQ loading on group selection for a seamless frontend experience
Define a custom URL for the FAQ page
Full GraphQL support to retrieve all FAQs, FAQs by group ID, and FAQ groups
Create and manage FAQ groups (categories) with editing capabilities
Provide detailed FAQ answers using a rich WYSIWYG editor
Assign store view visibility to individual FAQs and FAQ groups
Restrict FAQ and group visibility by customer group
Organize FAQs into groups for better navigation and user experience
Lightweight and easy-to-install extension with no impact on site performance
Supports multistore environments
Add custom icons to FAQ groups
Support for inserting images, static blocks, and widgets in FAQ answers
Support for collapse/expand view toggle on the FAQ page

Check full description and user guid on Magento Marketplace

📺 Demo

Frontend | Backend

🚀 Installation Instructions

1. Install from Magento Marketplace

Magento Marketplace Link

2. Install via composer (packagist.org)

Run the following Magento CLI commands:

composer require mageprince/module-faq
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy

3. Manual Installation

Copy the content of the repo to the Magento 2 app/code/Mageprince/Paymentfee

Run the following Magento CLI commands:

php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy

GraphQL

Get all FAQs

query faqs {
  faqs {
    faq_id
    title
    content
    group
    storeview
    customer_group
    sortorder
    status
    created_at
    updated_at
  }
}

Get FAQs by Group ID:

query faqs {
  faqs(groupId: 1) {
    faq_id
    title
    content
    group
    storeview
    customer_group
    sortorder
    status
    created_at
    updated_at
  }
}

Get all FAQ Groups

query faqs {
  faqGroups {
    faqgroup_id
    groupname
    icon
    storeview
    customer_group
    sortorder
    status
    created_at
    updated_at
  }
}

How to Display FAQs in CMS Pages or Static Blocks

1. To show all FAQ

{{block class="Mageprince\Faq\Block\Index\Index" template="Mageprince_Faq::faq_main.phtml" show_group_title=1 show_group=1 page_type="scroll"}}

2. To show FAQ by group

{{block class="Mageprince\Faq\Block\Index\Index" template="Mageprince_Faq::faq_main.phtml" group_id=1 show_group_title=1}}

🤝 Contribution

Want to contribute to this extension? The quickest way is to open a pull request on GitHub.

🛠 Support

If you encounter any problems or bugs, please open an issue on GitHub.

mageprince / module-faq

Maintainers

Details