Skip to content

Commit

Permalink
add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
atmonshi committed Nov 3, 2023
1 parent 68fc151 commit 97b0992
Show file tree
Hide file tree
Showing 8 changed files with 126 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,21 @@

<h4 align="center">Lara-zeus Matrix Choice is a multiple choice grid component form for filamentPHP.</h4>

<p align="center">

[![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)

</p>

## 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

Expand Down
7 changes: 7 additions & 0 deletions docs/_index.md
Original file line number Diff line number Diff line change
@@ -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
---
22 changes: 22 additions & 0 deletions docs/filament.md
Original file line number Diff line number Diff line change
@@ -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)
4 changes: 4 additions & 0 deletions docs/getting-started/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: Getting Started
weight: 1
---
15 changes: 15 additions & 0 deletions docs/getting-started/assets.md
Original file line number Diff line number Diff line change
@@ -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`
6 changes: 6 additions & 0 deletions docs/getting-started/changelog.md
Original file line number Diff line number Diff line change
@@ -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)
34 changes: 34 additions & 0 deletions docs/getting-started/installation.md
Original file line number Diff line number Diff line change
@@ -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',
]),
```
24 changes: 24 additions & 0 deletions docs/introduction.md
Original file line number Diff line number Diff line change
@@ -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)

0 comments on commit 97b0992

Please sign in to comment.