From 400ae58279d1c61e1ecba4efde17bd67c3fd678a Mon Sep 17 00:00:00 2001 From: Ash Monsh Date: Mon, 8 Jan 2024 02:10:36 +0300 Subject: [PATCH] update docs --- docs/_index.md | 6 +-- docs/filament.md | 27 ++++++------ docs/getting-started/changelog.md | 2 +- docs/getting-started/installation.md | 65 ++++++++-------------------- docs/introduction.md | 22 +++++----- 5 files changed, 46 insertions(+), 76 deletions(-) diff --git a/docs/_index.md b/docs/_index.md index b880b75..4007206 100644 --- a/docs/_index.md +++ b/docs/_index.md @@ -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 --- diff --git a/docs/filament.md b/docs/filament.md index 9435085..072f961 100644 --- a/docs/filament.md +++ b/docs/filament.md @@ -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) diff --git a/docs/getting-started/changelog.md b/docs/getting-started/changelog.md index 7f18f8a..e7e297b 100644 --- a/docs/getting-started/changelog.md +++ b/docs/getting-started/changelog.md @@ -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) diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md index dc4abc5..33c3a7e 100644 --- a/docs/getting-started/installation.md +++ b/docs/getting-started/installation.md @@ -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.'
'.$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.'
'.$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(), + ]), + ]), , -``` +``` \ No newline at end of file diff --git a/docs/introduction.md b/docs/introduction.md index b99102b..5838025 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -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)