Download the PHP package creativekallol/ck-faq without Composer
On this page you can find all versions of the php package creativekallol/ck-faq. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download creativekallol/ck-faq
More information about creativekallol/ck-faq
Files in creativekallol/ck-faq
Package ck-faq
Short Description Extension for managing and showcasing FAQ on the website frontend.
License MIT
Informations about the package ck-faq
TYPO3 FAQ Extension - ck_faq
Classification: ck_faq
Version: 1.0.0
Language: en, de
Description: This extension provides a flexible and powerful FAQ solution for TYPO3 CMS, featuring categorized listings, search functionality, pagination, and a user rating system.
Keywords: FAQ, TYPO3, Accordion, Rating, Search, Responsive, Bootstrap, Extbase, Fluid
Copyright: 2025
Author: Kallol Chakraborty
License: This document is published under the Open Content License available from https://www.opencontent.org/opl.shtml
The content of this document is related to TYPO3, a GNU/GPL CMS/Framework available from www.typo3.org.
βοΈ Features
- Categorized FAQ display with smart filtering
- Smart search (by title or description)
- Pagination support
- For anonymous users - Frontend rating using thumbs up/down with cookie protection (one-time vote per FAQ)
- For logged-in frontend users - Feature is upcoming!
- Localized output support (based on configured site language)
- Responsive UI using Bootstrap 5
- FAQ rich text support using RTE
- Fully Extbase & Fluid-based architecture
- Future-ready and compliant with TYPO3 v13
π¦ Installation
Install the extension via Composer:
π Plugin Configuration
After installation, follow these steps:
- Add the content element FAQ to a TYPO3 page.
- Create and assign FAQ categories using TYPO3βs native category system.
- Add FAQ records to a dedicated sys folder.
- Optionally, customize templates and styles via your sitepackage extension.
- Adjust TypoScript settings manually or through the Constant Editor.
Available Configuration Options:
- Storage PID: Limit FAQ records to a specific page/folder. If left empty, records will be fetched from all pages.
- Category Parent: Filter categories by a parent category. If not set, all categories will be listed.
- Items Per Page: Control pagination size. If not specified, a default value of
5will be used.
Once configuration is done, donβt forget to clear the TYPO3 cache.
π‘ Frontend Output
The extension renders:
- A sidebar of categories with active selection
- A search box (GET method) with a clear button
- An accordion list of FAQs with collapsible answers
- A rating bar (thumbs up/down)
- Pagination below FAQ listing
- Dynamic UI messages based on rating
- FAQs are sorted by most helpful votes first, then by least not-helpful votes, and finally by newest updates
πΈ Screenshot
π§ͺ Backend Enhancements
- Clean backend with helpful label formatting [e.g.,
FAQ Title (π 3, π 0)] - Category selection is managed using TYPO3βs native
sys_categorywith tree view
π SEO-Friendly Routing Advice
For optimal URL structure, you are encouraged to write your own custom site configuration using YAML. Alternatively, you may refer to the following example:
π TODO
- Turn ON/OFF the entire Rating feature, so that FAQ can be used with or without rating system
- Configure use of Bootstrap 5 CDN only if it is not available in sitepackage
- Enable rating system based on logged-in frontend users.
- Make the plugin configurable to allow update of rating data in real time or via batch processing (important for high-traffic websites).
π§° Technologies Used
- TYPO3 CMS 13.x
- Extbase & Fluid
- Bootstrap 5 (via CDN)
β€οΈ Support the Extension
This extension thrives with active sponsorship to stay updated in the TYPO3 ecosystem and remain compatible with future TYPO3 versions.
You can become a title sponsor of this extension.
π¬ Reach out to me at [email protected]
π Suggest a new feature?
If you want to suggest a feature or request something custom, feel free to email me at [email protected].
π Found a bug?
- First, check out the
mainbranch and verify that the issue hasnβt already been resolved. - Review the existing issues to avoid duplicates.
- If not found, report the bug in the issue tracker.
π€ Want to contribute?
We welcome contributions via pull requests.
Please ensure your commit messages follow a conventional format (e.g., [BUGFIX], [FEATURE]) and include clear details.
Good Luck!