Go to file
Sam Minnée c50f461a78
Merge pull request #165 from open-sausages/pulls/fix-list-values
FIX Preselect based on SS_List values
2020-08-12 13:32:50 +12:00
_config Setup TagField to work within AssetAdmin (Fixes #107) 2019-07-25 12:13:44 +12:00
client Code clean-up 2019-07-25 12:23:04 +12:00
docs/en Added screenshot 2019-07-04 09:11:11 +12:00
src FIX Preselect based on SS_List values 2020-07-16 17:45:04 +12:00
templates/SilverStripe/TagField Additional changes to convert tagfield to use react-select 2018-07-16 13:27:11 +12:00
tests FIX Preselect based on SS_List values 2020-07-16 17:45:04 +12:00
_config.php FIX Update module for latest SS4, vendorise 2017-10-18 14:19:15 +13:00
.editorconfig NEW Converting tagfield to use react components 2018-07-11 17:47:38 +12:00
.eslintrc.js Additional changes to convert tagfield to use react-select 2018-07-16 13:27:11 +12:00
.gitattributes Added standard git attributes 2015-11-19 19:13:48 +13:00
.gitignore FIX Adding a debounce to fetching lazy loaded tags with tag field 2018-12-04 16:15:47 +13:00
.nvmrc FIX Ensure tagfield is compatible with both React and Entwine contexts 2019-07-25 12:13:50 +12:00
.scrutinizer.yml FIX Update module for latest SS4, vendorise 2017-10-18 14:19:15 +13:00
.ss-storybook.js FIX Ensure tagfield is compatible with both React and Entwine contexts 2019-07-25 12:13:50 +12:00
.travis.yml Use travis node version 10 2020-06-18 14:27:54 +12:00
.upgrade.yml FIX SS4 compatibility updates, PSR-4 in tests, table_name in stubs 2017-06-22 17:15:17 +12:00
code-of-conduct.md Added standard code of conduct 2015-11-21 20:17:21 +13:00
codecov.yml FIX Update module for latest SS4, vendorise 2017-10-18 14:19:15 +13:00
composer.json Remove obsolete branch alias 2019-08-15 09:56:39 +12:00
contributing.md Made supported 2015-09-09 13:28:43 +12:00
license.md Updated license year 2016-01-01 06:38:06 +13:00
package.json Bump jquery from 3.4.1 to 3.5.0 2020-04-30 07:14:51 +00:00
phpcs.xml.dist Add individual phpcs ruleset to Travis builds 2018-08-18 10:09:56 +12:00
phpunit.xml.dist Remove cms dependance in unit tests 2020-07-16 09:35:15 +12:00
readme.md Add screenshot to readme 2019-07-04 09:11:50 +12:00
webpack.config.js NEW Converting tagfield to use react components 2018-07-11 17:47:38 +12:00
yarn.lock Bump npm from 6.13.4 to 6.14.7 2020-07-21 20:26:46 +00:00

Tag Field

Custom tag input field, for SilverStripe.

Build Status Code Quality Code coverage Version License SilverStripe supported module

Overview

Screenshot

Allows storing tags as a relationship, or comma-delimited strings. Supports autocompletion with lazy-loading.

Note: The field is optimised for usage in the SilverStripe CMS UI. The form field class itself can be used outside of the CMS, but you'll need to build your own frontend to interpret the raw field data (data-schema attribute).

Requirements

  • SilverStripe 4.0

Installing

$ composer require silverstripe/tagfield

Using

Relational Tags

use SilverStripe\ORM\DataObject;

class BlogPost extends DataObject
{
	private static $many_many = [
		'BlogTags' => BlogTag::class
	];
}
use SilverStripe\ORM\DataObject;

class BlogTag extends DataObject
{
	private static $db = [
		'Title' => 'Varchar(200)',
	];

	private static $belongs_many_many = [
		'BlogPosts' => BlogPost::class
	];
}
$field = TagField::create(
	'BlogTags',
	'Blog Tags',
	BlogTag::get(),
	$this->BlogTags()
)
	->setShouldLazyLoad(true) // tags should be lazy loaded
	->setCanCreate(true);     // new tag DataObjects can be created

Note: This assumes you have imported the namespaces class, e.g. use SilverStripe\TagField\TagField;

String Tags

use SilverStripe\ORM\DataObject;

class BlogPost extends DataObject
{
	private static $db = [
		'Tags' => 'Text',
	];
}
$field = StringTagField::create(
	'Tags',
	'Tags',
    ['one', 'two'],
	explode(',', $this->Tags)
);

$field->setShouldLazyLoad(true); // tags should be lazy loaded

You can find more in-depth documentation in docs/en.

Versioning

This library follows Semver. According to Semver, you will be able to upgrade to any minor or patch version of this library without any breaking changes to the public API. Semver also requires that we clearly define the public API for this library.

All methods, with public visibility, are part of the public API. All other methods are not part of the public API. Where possible, we'll try to keep protected methods backwards-compatible in minor/patch versions, but if you're overriding methods then please test your work before upgrading.

Reporting Issues

Please create an issue for any bugs you've found, or features you're missing.