diff --git a/README.md b/README.md index 19c1fc5..d6877fc 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,21 @@
+ +[![Latest Version on Packagist](https://img.shields.io/packagist/v/lara-zeus/multiple-choice.svg?style=flat-square)](https://packagist.org/packages/lara-zeus/multiple-choice) +[![Tests](https://img.shields.io/github/actions/workflow/status/lara-zeus/multiple-choice/run-tests.yml?label=tests&style=flat-square&branch=main)](https://github.com/lara-zeus/multiple-choice/actions?query=workflow%3Arun-tests+branch%3Amain) +[![Code Style](https://img.shields.io/github/actions/workflow/status/lara-zeus/multiple-choice/fix-php-code-style-issues.yml?label=code-style&flat-square)](https://github.com/lara-zeus/multiple-choice/actions?query=workflow%3Afix-php-code-style-issues+branch%3Amain) +[![Total Downloads](https://img.shields.io/packagist/dt/lara-zeus/multiple-choice.svg?style=flat-square)](https://packagist.org/packages/lara-zeus/multiple-choice) +[![Total Downloads](https://img.shields.io/github/stars/lara-zeus/multiple-choice?style=flat-square)](https://github.com/lara-zeus/multiple-choice) + +
+ ## features -- ๐ฅ Ready to use +- ๐ฅ use as a radio button +- ๐ฅ use as a checkbox button +- ๐ฅ set Column Data and Row Data +- ๐ฅ ask me for more ## Demo diff --git a/docs/_index.md b/docs/_index.md new file mode 100644 index 0000000..ae29019 --- /dev/null +++ b/docs/_index.md @@ -0,0 +1,7 @@ +--- +title: v3 +slogan: multiple choice grid component form for filamentPHP +githubUrl: https://github.com/lara-zeus/multiple-choice +branch: v3.x +icon: carbon-scatter-matrix +--- diff --git a/docs/filament.md b/docs/filament.md new file mode 100644 index 0000000..bf0a7d9 --- /dev/null +++ b/docs/filament.md @@ -0,0 +1,22 @@ +# Zeus Matrix Choice + +Matrix Choice is a multiple choice grid component form for filamentPHP + +## Features + +- ๐ฅ use as a radio button +- ๐ฅ use as a checkbox button +- ๐ฅ set Column Data and Row Data +- ๐ฅ ask me for more + +## Screenshots + +![](https://larazeus.com/images/screenshots/multiple-choice/form-1.png) + +## More Details +**โจ to learn more about Matrix Choice, please visit:** + +- [Discord](https://discord.com/channels/883083792112300104/1121563279668555897) +- [Docs](https://larazeus.com/docs/multiple-choice) +- [Github](https://github.com/lara-zeus/multiple-choice) +- [Demo](https://demo.larazeus.com/admin/users/create) diff --git a/docs/getting-started/_index.md b/docs/getting-started/_index.md new file mode 100644 index 0000000..4272691 --- /dev/null +++ b/docs/getting-started/_index.md @@ -0,0 +1,4 @@ +--- +title: Getting Started +weight: 1 +--- diff --git a/docs/getting-started/assets.md b/docs/getting-started/assets.md new file mode 100644 index 0000000..c1340de --- /dev/null +++ b/docs/getting-started/assets.md @@ -0,0 +1,15 @@ +--- +title: Themes and Assets +weight: 6 +--- + +## Compiling assets + +we use [tailwind Css](https://tailwindcss.com/) and custom themes by filament, make sure you are familiar with [tailwindcss configuration](https://tailwindcss.com/docs/configuration), and how to make custom [filament theme](https://filamentphp.com/docs/2.x/admin/appearance#building-themes). + +### Custom Classes: + +You need to add these files to your `tailwind.config.js` file in the `content` section. + +* filament: + * `./vendor/lara-zeus/multiple-choice/resources/views/**/*.blade.php` diff --git a/docs/getting-started/changelog.md b/docs/getting-started/changelog.md new file mode 100644 index 0000000..63f8777 --- /dev/null +++ b/docs/getting-started/changelog.md @@ -0,0 +1,6 @@ +--- +title: Changelog +weight: 100 +--- + +All changes to @zeus Bolt are auto updated documented on GitHub [changelog](https://github.com/lara-zeus/bolt/blob/main/CHANGELOG.md) diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md new file mode 100644 index 0000000..16aba29 --- /dev/null +++ b/docs/getting-started/installation.md @@ -0,0 +1,34 @@ +--- +title: Installation +weight: 3 +--- + +## Installation + +Install @zeus Matrix Choice by running the following commands in your Laravel project directory. + +```bash +composer require lara-zeus/multiple-choice +``` + +## Usage: + +use it in your resource + +```php +Matrix::make('question') + ->label('Tell us about your mod') + ->asRadio() + // or + ->asCheckbox() + ->columnData([ + '๐', + '๐', + '๐', + ]) + ->rowData([ + 'Saturday', + 'Sunday', + 'Monday', + ]), +``` diff --git a/docs/introduction.md b/docs/introduction.md new file mode 100644 index 0000000..991f0a0 --- /dev/null +++ b/docs/introduction.md @@ -0,0 +1,24 @@ +--- +title: Introduction +weight: 1 +--- + +## Introduction +@zeus Matrix Choice is a multiple choice grid component form for filamentPHP. + +**[Demo](https://demo.larazeus.com/admin/users/create) ยท [Github](https://github.com/lara-zeus/multiple-choice) ยท [Discord](https://discord.com/channels/883083792112300104/1121563279668555897)** + +## features + +- ๐ฅ use as a radio button +- ๐ฅ use as a checkbox button +- ๐ฅ set Column Data and Row Data +- ๐ฅ ask me for more + +## Support + +Available support channels: + +* Join our channel in discord [Discord](https://discord.com/channels/883083792112300104/1121563279668555897) +* open an issue on [GitHub](https://github.com/lara-zeus/multiple-choice/issues) +* Email us using the [contact center](https://still-code.com/contact-us/lara-zeus)