Skip to content

Commit

Permalink
Merge pull request #239 from lara-zeus/update-docs
Browse files Browse the repository at this point in the history
update docs
  • Loading branch information
atmonshi authored Jan 13, 2024
2 parents df3017f + a470cb1 commit 87702dc
Show file tree
Hide file tree
Showing 12 changed files with 219 additions and 46 deletions.
2 changes: 1 addition & 1 deletion docs/_index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: v2
title: v3
slogan: form builder for your users, with so many use cases.
githubUrl: https://github.com/lara-zeus/bolt
branch: main
Expand Down
2 changes: 1 addition & 1 deletion docs/advanced/_index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
title: Advanced
weight: 4
weight: 3
---
43 changes: 0 additions & 43 deletions docs/bolt-pro.md

This file was deleted.

4 changes: 4 additions & 0 deletions docs/bolt-pro/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: Bolt Pro
weight: 4
---
26 changes: 26 additions & 0 deletions docs/bolt-pro/advanced-tables.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
title: Integrated with Advanced Tables
weight: 5
---

The Advanced Tables (formerly Filter Sets) plugin from [Kenneth Sese](https://filamentphp.com/plugins/kenneth-sese-advanced-tables), to Supercharge your tables with powerful features like user customizable views, enhanced filter tabs, reorderable columns, convenient view management, and more. now, fully integrated to create powerful reports from your dynamic forms.

You will need a separate license for the Advanced Tables plugin to activate these features.

## enable the Advanced Tables Plugin

after installing Advanced Tables, the the filters will be available in forms immediately.

but you need to enable it in the Entries Report page:

create the file
`resources/views/vendor/zeus/filament/pages/reports/entries-pro.blade.php`
or copy it from the vendor folder
and add the content:

```html
<x-filament::page class="space-y-6">
<x-advanced-tables::favorites-bar/>
{{ $this->table }}
</x-filament::page>
```
17 changes: 17 additions & 0 deletions docs/bolt-pro/fields.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: Available Fields
weight: 2
---

## Available Fields

- 🔥 Rating. Show Star Rating as field
- 🔥 Matrix Grid. multiple choice grid field as radio or checkboxes
- 🔥 Slider. a range selector, set the min and max value
- 🔥 Advance Date. set the date picker to range, month, week, and multiple dates
- 🔥 Alert. show a note with customized styling
- 🔥 Icon Picker. allows your users to pick an icon
- 🔥 Image Picker. allows users to pick an image from uploaded set
- 🔥 Dynamic Textbox. add multiple text values
- 🔥 Signature. collect users signature
- 🔥 terms and conditions. let the users agree to your terms and conditions
45 changes: 45 additions & 0 deletions docs/bolt-pro/introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
title: Introduction
weight: 1
---

## Zeus Bolt Pro

Advanced Forms management, More Filtering, Presets, and New Fields for Bolt the form builder

## Features

- New Fields Types
- Advanced widgets and stats
- Forms API
- Custom colors and branding per form
- Presets: create Forms with pre defined templates, or from existing forms
- Prefilled Forms URLs
- Advanced Widgets
- Sharing and embedding the form

### Get Bolt Pro from [here](https://larazeus.com/bolt-pro)

## Installation

To install bolt, you only need to require it in your composer by running the command:

```bash
composer require lara-zeus/bolt-pro
```

and that is all :).

you will get more details after you purchasing the package.

## Configuration

add these configuration keys to `zeus-bolt` config file:

```php
// if you want to disable the preset button
'allow_design' => false,

// to disable the theming tab
'show_presets' => false,
```
20 changes: 20 additions & 0 deletions docs/bolt-pro/presets.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: Presets Forms
weight: 3
---

# Presets Forms:
Create Forms with pre defined templates, build your form manually or use an existing form.
Available Preset: Support Ticket, Contact Form.

## Create a new preset

use the artisan command to create new preset:

`make:zeus-preset`

this will prompts you to enter the preset class name without any namespace
or the form ID from you existing forms.

all new generated presets will be saved in the folder: `App\Zeus\Presets`

74 changes: 74 additions & 0 deletions docs/bolt-pro/share-form.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
---
title: Sharing & Embedding
weight: 4
---

# Sharing a Form:

Bolt Pro will provide your users with a new tab, that let them share the form to social media and other webpages very easily.

To customize the social media sharing icons or use any other widget, create the file:
`resources/views/vendor/zeus/filament/social-share.blade.php`.

and add any social platform you want.

## Embedding a Form

the embed forms will be accessible from the route name `bolt.form.embed`
the url is; `/bolt/embed/$form->slug`

to customize the layout you can create the file:
`resources/views/vendor/zeus/filament/embed-layout.blade.php`

the default content:

```html
<!DOCTYPE html>
<html lang="{{ str_replace('_', '-', app()->getLocale()) }}" dir="{{ __('filament-panels::layout.direction') ?? 'ltr' }}" class="antialiased filament js-focus-visible">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="csrf-token" content="{{ csrf_token() }}">
<meta name="application-name" content="{{ config('app.name', 'Laravel') }}">

<!-- Seo Tags -->
<x-seo::meta/>
<!-- Seo Tags -->

<link rel="preconnect" href="https://fonts.googleapis.com">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link href="https://fonts.googleapis.com/css2?family=Almarai:wght@300;400;700;800&family=KoHo:ital,wght@0,200;0,300;0,500;0,700;1,200;1,300;1,600;1,700&display=swap" rel="stylesheet">

@livewireStyles
@filamentStyles
@stack('styles')

<link rel="stylesheet" href="{{ asset('vendor/zeus/frontend.css') }}">

<style>
* {font-family: 'KoHo', 'Almarai', sans-serif;}
[x-cloak] {display: none !important;}
</style>
</head>
<body class="font-sans antialiased bg-gray-50 text-gray-900 dark:text-gray-100 dark:bg-gray-900 @if(app()->isLocal()) debug-screens @endif">

<div class="container mx-auto my-6">
{{ $slot }}
</div>

@stack('scripts')
@livewireScripts
@filamentScripts
@livewire('notifications')

<script>
const theme = localStorage.getItem('theme')
if ((theme === 'dark') || (! theme && window.matchMedia('(prefers-color-scheme: dark)').matches)) {
document.documentElement.classList.add('dark')
}
</script>

</body>
</html>
```
1 change: 1 addition & 0 deletions docs/filament-bolt-pro.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ Advanced Forms management, More Filtering, Presets, and New Fields for [Bolt the
* Custom colors and branding per form
* Prefilled Forms URLs
* Advanced Widgets
* Sharing and embedding the form

## Fully Integrated with Advanced Tables.

Expand Down
26 changes: 26 additions & 0 deletions docs/getting-started/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,9 @@ BoltPlugin::make()

->navigationGroupLabel('Bolt')

->hideNavigationBadges(resource: LaraZeus\Bolt\Resources::CollectionResource)
->showNavigationBadges(resource: LaraZeus\Bolt\Resources::CollectionResource)

->extensions([
Thunder::class,
])
Expand All @@ -54,6 +57,29 @@ FormResource::navigationIcon('heroicon-o-home');
FormResource::navigationGroup('New Name');
```

### Show or Hide Badges

To show all navigation badges (default)
```
->showNavigationBadges()
```

To hide all navigation badges
```
->hideNavigationBadges()
```

This will hide only the CollectionResource navigation badge
```
->hideNavigationBadges(resource: LaraZeus\Bolt\Resources::CollectionResource)
```

This will show only the FormResource navigation badge
```
->hideNavigationBadges()
->showNavigationBadges(resource: LaraZeus\Bolt\Resources::CollectionResource)
```

available resources:

- CategoryResource,
Expand Down
5 changes: 4 additions & 1 deletion docs/usage/embed.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,7 @@ if you are using our package @zeus [Sky](https://larazeus.com/sky), you can embe
<bolt>formSlug</bolt>
```

And for your user's convenience, we added a new tab in the form to make it easy to copy the code.
## Sharing on the Web
with bolt pro, and for your user's convenience, we added a new tab in the form to make it easy to copy the code.

read more about it in [Bolt Pro share-form](../bolt-pro/share-form)

0 comments on commit 87702dc

Please sign in to comment.