Viewi Viewi

Documentation

Viewi v2

  1. Introduction
  2. Get started
  3. Installation
  4. Configuration
  5. Watching mode
  6. Creating Components
  7. Template Syntax
  8. Conditional Rendering
  9. List Rendering
  10. Event Handling
  11. Form input bindings
  12. Components Basics
  13. Components and services
  14. Components In-Depth
  15. Extending with JavaScript
  16. Routing
  17. Lazy loading routes and components
  18. Guards and Middleware
  19. Reusing layouts
  20. Client route
  21. Data fetching and HTTP client
  22. HTTP interceptors
  23. Portals
  24. Viewi assets
  25. CSS bundle
  26. Public configuration
  27. Frameworks integration and bridge
  28. ReactPHP
  29. CodeIgniter4
  30. Laravel

Installation

Requirements

PHP >= 8.0
Node.js >= 12

Install a Viewi Package

composer require viewi/viewi

Create a new application with Viewi CLI tool

vendor/bin/viewi new [-f folder] [-a]

Where -f folder is an optional parameter and can be omitted.

Where -a means you are going to use an adapter and you do not need to modify the index.php file. Usually you use -a when installing Viewi with another framework. It is an optional parameter and can be omitted.

It will generate for you the default code for using Viewi as a standalone application in one of these files: /index.php or /public/index.php.

If you specified folder parameter, your components will be located in that folder, otherwise it will use one of these: viewi-app/ or src/ViewiApp/.

Important To use it with the Apache or NGINX you need to make sure that all requests are coming to the index.php file by using rewrite rules.

Important Viewi does not support running from a subdirectory as sub url path. Please adapt your application accordingly.