https://github.com/spantaleev/ckeditor-imagebrowser

Image Browser plugin for CKEditor
https://github.com/spantaleev/ckeditor-imagebrowser

Last synced: 3 months ago
JSON representation

Image Browser plugin for CKEditor

• Host: GitHub
• URL: https://github.com/spantaleev/ckeditor-imagebrowser
• Owner: spantaleev
• License: bsd-3-clause
• Created: 2013-03-24T11:30:40.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2014-01-11T20:16:58.000Z (almost 11 years ago)
• Last Synced: 2024-04-09T22:46:23.840Z (9 months ago)
• Language: JavaScript
• Homepage: http://ckeditor.com/addon/imagebrowser
• Size: 1.24 MB
• Stars: 28
• Watchers: 6
• Forks: 25
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# CKEditor Image Browser plugin

**imagebrowser** is a [CKEditor](http://ckeditor.com/) plugin that allows images on the server to be browsed and picked for inclusion into the editor's contents.

You can view the working demo [HERE](http://devture.com/projects/ckeditor-imagebrowser).

![screenshot](https://raw2.github.com/spantaleev/ckeditor-imagebrowser/demo/ckeditor-imagebrowser-screenshot.jpg)

This plugin integrates with the **image** plugin (part of CKEditor), by making it provide a **Browse Server** button in the Image dialog window.

The way you use it is very similar to `imageGetJson` in [Redactor](http://imperavi.com/redactor/)

- you only need to provide a list of images in a JSON format, and the image browser will take care of the rest.

In fact, it uses the same data format as Redactor, allowing for an easy transition between the two editors.

## Installation

Copy the whole contents of this repository into a new `plugins/imagebrowser` directory in your CKEditor install.

Make sure you're using the **Standard** or **Full** [CKEditor packages](http://ckeditor.com/download).

The **Basic** package lacks an in-built "File Browser" plugin, which this plugin depends on. You can also use a [Custom CKEditor package](http://ckeditor.com/builder>), if you build it with "File Browser" plugin support.

## Usage

Enable the plugin by adding it to `extraPlugins` and specify the `imageBrowser_listUrl` parameter:

	

	

		CKEDITOR.replace('my-textarea-id', {

			"extraPlugins": "imagebrowser",

			"imageBrowser_listUrl": "/path/to/images_list.json"

		});

	

The `imageBrowser_listUrl` configuration parameter points to a URL that lists the server's images in a JSON format.

**Make sure to use an absolute path.**

Example:

	[

		{

			"image": "/image1_200x150.jpg",

			"thumb": "/image1_thumb.jpg",

			"folder": "Small"

		},

		{

			"image": "/image2_200x150.jpg",

			"thumb": "/image2_thumb.jpg",

			"folder": "Small"

		},

		{

			"image": "/image1_full.jpg",

			"thumb": "/image1_thumb.jpg",

			"folder": "Large"

		},

		{

			"image": "/image2_full.jpg",

			"thumb": "/image2_thumb.jpg",

			"folder": "Large"

		}

	]

The above says that there are 2 image directories ("Small" and "Large") with 2 files in each of them.

 * **image** - the absolute path being used when the image gets put into the editor's contents.

 * **thumb** (optional) - the relative path to the image's thumbnail (for preview purposes). (if omitted, the value of **image** is used as a thumbnail.)

 * **folder** field is *optional*. If omitted, the image list will not be split into folders.

## Another way to initiliaze

If you want the image browser plugin to work for all of your CKEditor textareas, you can edit CKEditor's `config.js` and add the 2 configuration lines:

	config.extraPlugins = "imagebrowser";

	config.imageBrowser_listUrl = "/path/to/images_list.json";