Download the PHP package atk14/color-field without Composer

On this page you can find all versions of the php package atk14/color-field. 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?

Informations about the package color-field

ColorField

ColorField is a form field for entering color in HEX, HEXA, RGB or RGBA format.

Installation

Just use the Composer:

cd path/to/your/atk14/project/
composer require atk14/color-field

ln -s ../../vendor/atk14/color-field/src/app/fields/color_field.php app/fields/color_field.php

Integration with Pickr

By default, ColorField renders in which values like , , can be written. Nothing interesting... But ColorField is meant to be integrated with a nice color picker called Pickr (see https://github.com/Simonwep/pickr).

Pickr can be installed using npm:

npm install --save npm install @simonwep/pickr

And a small js utility needs to be linked into the project:

ln -s ../../../vendor/atk14/color-field/src/public/scripts/utils/color_picker_initializer.js public/scripts/utils/color_picker_initializer.js

Now edit gulpfile-admin.js (or gulpfile.js):

var vendorStyles = [
  // ...

  // ColorPickr: Include one of the following themes
  "node_modules/@simonwep/pickr/dist/themes/classic.min.css"
  //"node_modules/@simonwep/pickr/dist/themes/monolith.min.css"
  //"node_modules/@simonwep/pickr/dist/themes/nano.min.css"
];

// ...

var vendorScripts = [
  // ...

  // ColorPickr: modern or es5 bundle (in here, the modern bundle fails)
  //"node_modules/@simonwep/pickr/dist/pickr.min.js"
  "node_modules/@simonwep/pickr/dist/pickr.es5.min.js"
];

// ...

var applicationScripts = [
  // ...

  "public/scripts/utils/color_picker_initializer.js",

  // ...
];

Finally place the following line into function common.init() in public/admin/scripts/application.js (or public/scripts/application.js).

UTILS.color_picker_initializer.init();

Usage in an ATK14 application

In a form:

<?php
// file: app/forms/pages/create_new_form.php
class CreateNewForm extends AdminForm {

  function set_up(){
    // ...
    $this->add_field("background_color", new ColorField([
      "label" => "Background color",
      "initial" => "#4455ff",
      "opacity" => false,
      "theme" => "classic", // "classic", "monolith" or "nano"
      "swatches" => ["#4455ff", "#3366ee", "#223388","rgb(122,233,77)"]
    ]));
  }
}

Swatches

If the configuration file config/theme/colors.json or config/theme/colors.yml exists, ColorField will use the colors from this file as default swatches. The contents of the file might look like this:

{
  "primary": "#e75a76",
  "secondary": "#6c757d",
  "success": "#32a555",
  "info": "#17a2b8",
  "warning": "#ccb11b",
  "danger": "#e70000",
  "light": "#f5f5f5",
  "dark": "#343a40",
  "brand": "#307fa5"
}

Testing

composer update --dev
cd test
../vendor/bin/run_unit_tests

License

ColorField is free software distributed under the terms of the MIT license


All versions of color-field with dependencies

PHP Build Version
Package Version
Requires php Version >=5.3.0
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 atk14/color-field contains the following files

Loading the files please wait ....