{"id":18422736,"url":"https://github.com/alim1496/react-faq-generator","last_synced_at":"2025-04-07T15:32:26.126Z","repository":{"id":185520924,"uuid":"673665580","full_name":"alim1496/react-faq-generator","owner":"alim1496","description":"A simple FAQ section generator for React applications.","archived":false,"fork":false,"pushed_at":"2023-08-15T07:48:31.000Z","size":122,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-22T20:25:33.688Z","etag":null,"topics":["faq","react","rollup","typecsript","vitest"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/react-faq-generator","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/alim1496.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-08-02T06:37:27.000Z","updated_at":"2024-02-08T18:50:37.000Z","dependencies_parsed_at":null,"dependency_job_id":"c5251c9b-1395-4b5a-ba82-73c923338055","html_url":"https://github.com/alim1496/react-faq-generator","commit_stats":null,"previous_names":["alim1496/react-faq-generator"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alim1496%2Freact-faq-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alim1496%2Freact-faq-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alim1496%2Freact-faq-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alim1496%2Freact-faq-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alim1496","download_url":"https://codeload.github.com/alim1496/react-faq-generator/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247679778,"owners_count":20978121,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["faq","react","rollup","typecsript","vitest"],"created_at":"2024-11-06T04:32:50.323Z","updated_at":"2025-04-07T15:32:23.205Z","avatar_url":"https://github.com/alim1496.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# react-faq-generator\n\nThis repository contains a simple Frequently Asked Questions Section generator in React applications.\n\n## Installation\n\n### NPM\n```sh\nnpm install react-faq-generator\n```\n\n### YARN\n```sh\nyarn add react-faq-generator\n```\n\n## Usage\n```js\nimport React from 'react'\nimport FAQGenerator from 'react-faq-generator'\n\nconst MyApp = () =\u003e {\n\tconst data = [\n\t\t{\n\t\t\tid: 1,\n\t\t\tquestion: 'What was the main cause of World War I?',\n\t\t\tanswer: 'World War I began after the assassination of Austrian archduke Franz Ferdinand by South Slav nationalist Gavrilo Princip on June 28, 1914.'\n\t\t},\n\t\t{\n\t\t\tid: 2,\n\t\t\tquestion: 'What countries fought in World War I?',\n\t\t\tanswer: 'The war pitted the Central Powers (mainly Germany, Austria-Hungary, and Turkey) against the Allies (mainly France, Great Britain, Russia, Italy, Japan, and, from 1917, the United States).'\n\t\t},\n\t\t{\n\t\t\tid: 3,\n\t\t\tquestion: 'How was trench warfare used in World War I?',\n\t\t\tanswer: 'The widespread use of machine guns and rapid-firing artillery pieces on the Western Front meant that any exposed soldier was vulnerable.'\n\t\t}\n\t]\n\n\treturn (\n\t\t\u003cFAQGenerator data={data} /\u003e\n\t)\n}\n\nexport default MyApp\n```\n\n## Live Demo\nYou can check the live demo [here](https://codesandbox.io/s/funny-https-vjdt49?file=/src/App.tsx)\n\n## Properties\n\n| Property    | Type            | Default Value          | Description                                                                |\n|-------------|-----------------|------------------------|----------------------------------------------------------------------------|\n| `data`      | array of object | null                   | An array of questions \u0026 answers to be displayed. This prop must be passed. |\n| `title`     | string          | 'FAQ'                  | The title of the FAQ section.                                              |\n| `className` | string          | ''                     | The name of the class containing customm css rules to be applied.          |\n| `darkMode`  | boolean         | false                  | If in dark mode then pass this prop as `true`.                             |\n\n\n## License\n\nMIT © [alim1496](https://github.com/alim1496)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falim1496%2Freact-faq-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falim1496%2Freact-faq-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falim1496%2Freact-faq-generator/lists"}