silverstripe/superglue

There is no license information available for the latest version (1.0.0) of this package.

Installs: 414

Dependents: 0

Suggesters: 0

Security: 0

Stars: 10

Watchers: 6

Forks: 4

Open Issues: 2

Type:silverstripe-vendormodule

1.0.0 2019-06-04 01:28 UTC

This package is auto-updated.

Last update: 2020-06-05 04:04:46 UTC


README

Connect interesting pages to your landing page, with minimal effort!

Installation

$ composer require silverstripe/superglue

Docs

You can find an overview on the SilverStripe blog!

Example Usage

An example usage for Superglue would be if you have a list of featured news & events. By default, you may want to display the latest 4 items. However, if there's a special news aritcle or event you may want to pin this, giving it a higher priority than the standard news articles and then display the rest of the list afterwards. Here's an example of what that looks like with Superglue.

Select your pinned items in the CMS:

A screen recording of the CMS showing the content author clicking a "pin" button in a list of unpinned items, and the item moving to the "pinned" list of items above

The pinned items appear first, followed by a default list of non-pinned items.

A screen shot of the website showing the two selected pinned items appearing first and a default list of items apearing afterwards

Tests

Working on the tests. So far they've been rolled into the first site this was used on, and we're in the process of extracting them...

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.