Download the PHP package clesson-de/silverstripe-dashboard without Composer

On this page you can find all versions of the php package clesson-de/silverstripe-dashboard. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of clesson-de/silverstripe-dashboard

Informations about the package silverstripe-dashboard

Silverstripe Dashboard

A configurable dashboard field for Silverstripe CMS. It renders a full-width, React-powered panel grid inside any CMS form. Users can rearrange panels via drag & drop, toggle visibility, and configure auto-refresh intervals. Panel state is persisted per user.

Features

Requirements

Installation

Then run:

Usage

Adding a Dashboard to a CMS Form

Use DashboardField in any getCMSFields() method:

Creating a Custom Panel

Create a class that extends DashboardPanel:

The getResourceURL() must return a URL that serves HTML content. The dashboard loads this via fetch() and renders it inside the panel.

Configuration Options

Panel Width

Panels support two widths:

Auto-Refresh

Set getDefaultRefreshInterval() to a value in seconds. 0 disables auto-refresh (default).

Panel Assets

Panels can optionally provide custom CSS and JavaScript files:

API Endpoints

All endpoints require an authenticated CMS user.

Method URL Description
GET /dashboard-api/config?key={dashboardKey} Returns the panel config for the current user
POST /dashboard-api/config Saves the panel config (requires SecurityID token)
GET /dashboard-api/panels?key={dashboardKey} Lists all available panel classes

Frontend Assets

The module ships with compiled admin CSS and JS in client/admin/dist/. If you want to modify the styles or scripts, you need to recompile them.

Prerequisites

The required Node.js version is defined in .nvmrc. Switch to it with:

Install dependencies

Build

This compiles:

Watch mode (during development)

Output files

The compiled files in client/admin/dist/ are exposed via composer vendor-expose and referenced in PHP via Requirements::css() / Requirements::javascript(). Their filenames are static — they must not be renamed.

Developer Documentation

Architecture

The dashboard is split into a PHP backend and a React frontend:

Creating Panels

  1. Create a class extending Clesson\Silverstripe\Dashboard\Panels\DashboardPanel
  2. Implement getTitle() — return a translated panel title
  3. Implement getResourceURL() — return a URL that serves HTML content
  4. Optionally override getDefaultWidth(), getDefaultRefreshInterval(), getCSS(), getJavaScript()
  5. Run /dev/build?flush=all — the panel is automatically discovered

Panel Content Endpoint

The URL returned by getResourceURL() must serve content that can be rendered as HTML. The dashboard fetches this URL and injects the response via innerHTML. You can return:

User Configuration Model

DashboardUserConfig stores:

Field Type Description
DashboardKey Varchar(100) Identifies which dashboard
PanelClass Varchar(255) FQCN of the panel class
Sort Int Display order
Width Varchar(10) 'single' or 'double'
RefreshInterval Int Auto-refresh in seconds
Visible Boolean Whether the panel is shown
MemberID Int The owning user

License

BSD-3-Clause. See LICENSE.

All versions of silverstripe-dashboard with dependencies

PHP Build Version
Package Version
Requires silverstripe/framework Version ^6
silverstripe/admin Version ^3
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package clesson-de/silverstripe-dashboard contains the following files

Loading the files please wait ...