Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
atmonshi committed Jan 7, 2024
1 parent 12c5d06 commit 400ae58
Show file tree
Hide file tree
Showing 5 changed files with 46 additions and 76 deletions.
6 changes: 3 additions & 3 deletions docs/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: v1
slogan: filamentphp component to show a Popover with custom content in tables and infolist
githubUrl: https://github.com/lara-zeus/popover
slogan: filamentphp layout Group forms component in an Accordion layout
githubUrl: https://github.com/lara-zeus/accordion
branch: v1.x
icon: grommet-tip
icon: vaadin-accordion-menu
---
27 changes: 13 additions & 14 deletions docs/filament.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,23 @@
# Zeus Popover Component
# Zeus Accordion layout Component

Popover (tippyjs) with custom content in tables and infolist
Group forms component in an Accordion layout

## Features

## features
- 🔥 trigger (click)
- 🔥 placement (right)
- 🔥 offset from the content
- 🔥 Max Width
- 🔥 icon
🔥 same look and feel as filament components
🔥 can be used as connected accordion, or isolated
🔥 set the active accordion
🔥 set icon per accordion

## Screenshots

![](https://larazeus.com/images/screenshots/popover/popover-1.jpeg)
![](https://larazeus.com/images/screenshots/accordion/accordion-1.png)
![](https://larazeus.com/images/screenshots/accordion/cover.png)

## More Details
**✨ to learn more about Popover, please visit:**
**✨ to learn more about Accordion, please visit:**

- [Discord](https://discord.com/channels/883083792112300104/1191457684856246353)
- [Docs](https://larazeus.com/docs/popover)
- [Github](https://github.com/lara-zeus/popover)
- [Demo](https://demo.larazeus.com/admin/users)
- [Discord](#)
- [Docs](https://larazeus.com/docs/accordion)
- [Github](https://github.com/lara-zeus/accordion)
- [Demo](https://demo.larazeus.com/admin/accordion)
2 changes: 1 addition & 1 deletion docs/getting-started/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ title: Changelog
weight: 100
---

All changes to @zeus `Popover` are auto updated documented on GitHub [changelog](https://github.com/lara-zeus/Popover/blob/1.x/CHANGELOG.md)
All changes to @zeus `Accordion` are auto updated documented on GitHub [changelog](https://github.com/lara-zeus/Accordion/blob/1.x/CHANGELOG.md)
65 changes: 18 additions & 47 deletions docs/getting-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,59 +5,30 @@ weight: 3

## Installation

Install @zeus Popover by running the following commands in your Laravel project directory.
Install @zeus Accordion by running the following commands in your Laravel project directory.

```bash
composer require lara-zeus/popover
composer require lara-zeus/accordion
```

## Usage:

### use it in your table:
### use it in your form:

```php
\LaraZeus\Popover\Tables\PopoverColumn::make('name')
// most of filament methods will work
->sortable()
->searchable()
->toggleable()

// main options
->trigger('click') // for more: https://atomiks.github.io/tippyjs/v6/all-props/#trigger
->placement('right') // for more: https://atomiks.github.io/tippyjs/v6/all-props/#placement
->offset([0, 10]) // for more: https://atomiks.github.io/tippyjs/v6/all-props/#offset
->popOverMaxWidth('none') // for more: https://atomiks.github.io/tippyjs/v6/all-props/#maxwidth
->icon('heroicon-o-chevron-right') // show custom icon

// direct HTML content
->content(fn($record) => new HtmlString($record->name.'<br>'.$record->email))

// or blade content
->content(fn($record) => view('filament.test.user-card', ['record' => $record]))

// or livewire component
->content(fn($record) => new HtmlString(Blade::render('@livewire(\App\Filament\Widgets\Stats::class, ["lazy" => true])')))
,
```

### use it in your infolist:

```php
\LaraZeus\Popover\Infolists\PopoverEntry::make('name')
// main options
->trigger('click') // for more: https://atomiks.github.io/tippyjs/v6/all-props/#trigger
->placement('right') // for more: https://atomiks.github.io/tippyjs/v6/all-props/#placement
->offset([0, 10]) // for more: https://atomiks.github.io/tippyjs/v6/all-props/#offset
->popOverMaxWidth('none') // for more: https://atomiks.github.io/tippyjs/v6/all-props/#maxwidth
->icon('heroicon-o-chevron-right') // show custom icon

// direct HTML content
->content(fn($record) => new HtmlString($record->name.'<br>'.$record->email))

// or blade content
->content(fn($record) => view('filament.test.user-card', ['record' => $record]))

// or livewire component
->content(fn($record) => new HtmlString(Blade::render('@livewire(\App\Filament\Widgets\Stats::class, ["lazy" => true])')))
Accordions::make('Options')
->activeAccordion(2)
->isolated()

->accordions([
\LaraZeus\Accordion\Forms\Accordion::make('main-data')
->columns()
->label('User Details')
->icon('iconpark-commentone')
->schema([
TextInput::make('name')->required(),
TextInput::make('email')->required(),
]),
]),
,
```
```
22 changes: 11 additions & 11 deletions docs/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,26 @@ weight: 1
---

## Introduction
@zeus Popover is filamentphp component to show a Popover (tippyjs) with custom content in tables and infolist
Group forms component in an Accordion layout

**[Demo](https://demo.larazeus.com/admin/users) · [Github](https://github.com/lara-zeus/popover) · [Discord](https://discord.com/channels/883083792112300104/1191457684856246353)**
**[Demo](https://demo.larazeus.com/admin/accordion) · [Github](https://github.com/lara-zeus/accordion) · [Discord](#)**

## features
## Features

- 🔥 trigger (click)
- 🔥 placement (right)
- 🔥 offset from the content
- 🔥 Max Width
- 🔥 icon
- 🔥 same look and feel as filament components
- 🔥 can be used as connected accordion, or isolated
- 🔥 set the active accordion
- 🔥 set icon per accordion

## Screenshots

![](https://larazeus.com/images/screenshots/popover/popover-1.jpeg)
![](https://larazeus.com/images/screenshots/accordion/accordion-1.png)
![](https://larazeus.com/images/screenshots/accordion/cover.png)

## Support

Available support channels:

* Join our channel in discord [Discord](https://discord.com/channels/883083792112300104/1191457684856246353)
* Open an issue on [GitHub](https://github.com/lara-zeus/popover/issues)
* Join our channel in discord [Discord](#)
* Open an issue on [GitHub](https://github.com/lara-zeus/accordion/issues)
* Email us using the [contact center](https://larazeus.com/contact-us)

0 comments on commit 400ae58

Please sign in to comment.