diff --git a/README.md b/README.md index 02a72be..8710e7d 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,4 @@ + # Bring the power of DriverJs to your Filament panels and start a tour ! With the power of [DriverJS](https://driverjs.com) bring to your users an elegant way to discover your panels ! @@ -61,7 +62,7 @@ Let's follow this example to add a tour to your dashboard page. If you don't already have a customized dashboard, please refer to the following tutorial: [FIlamentPHP - Dashboard - Customizing the dashboard page](https://filamentphp.com/docs/3.x/panels/dashboard#customizing-the-dashboard-page) -- Use the correct trait to registers your tours ! +## Use the correct trait to registers your tours ! ```php get("TourDashboard.json")) + ]; +} +``` + +> [!IMPORTANT] +> Using `Tour::make(url: "")` or `Tour::make(json: "")` is the same thing, so don't worry about the name of your parameter if you've got the wrong type.
+> BUT
+> If you use `Tour::make('my-tour')` it's equal to `Tour::make(id: 'my-tour')` +> And here you need to construct all your steps. No JSON reading here. + +
+ JSON Example file (click to expand) or Github Gist Link + +```json +{ + "id": "dashboard", + "route": "/admin/test-team", + "colors": [ + "", + "" + ], + "alwaysShow": true, + "visible": true, + "uncloseable": true, + "ignoreRoutes": false, + "disableEvents": true, + "nextButtonLabel": "Next", + "previousButtonLabel": "Previous", + "doneButtonLabel": "Done", + "steps": [ + { + "title": "Woaw ! First Step !", + "description": "Yeah ! And I'm from a json file !", + "uncloseable": false, + "events": { + "clickOnNext": "body", + "notifyOnNext": { + "title": "Hello World !", + "body": "Woaw ! I'm from a Json file !", + "color": "success" + }, + "redirectOnNext": { + "url": "https://filamentphp.com", + "newTab": true + }, + "dispatchOnNext": [ + "open-modal", + { + "id": "edit-user" + } + ] + } + }, + { + "title": "An other one !", + "description": "Yeah ! And I'm from the same json file !", + "uncloseable": false, + "events": { + "clickOnNext": "body", + "notifyOnNext": { + "title": "Hello World !", + "body": "Woaw ! I'm from a Json file !", + "color": "success" + }, + "redirectOnNext": { + "url": "https://filamentphp.com", + "newTab": true + }, + "dispatchOnNext": [ + "open-modal", + { + "id": "edit-user" + } + ] + } + } + ] +} +``` +
+ # Tour.php ### Tour methods reference @@ -110,6 +210,9 @@ public function tours(): array { // Instanciate a tour, and provide an id, to trigger it later Tour::make(string $id) +// Since 3.1.0.1, JSON Support update +Tour::make(... $params) + // Define a custom url to trigger your tour ->route(string $route) @@ -229,7 +332,7 @@ public function highlights(): array { ]; } -```` +``` ___