{"id":18382413,"url":"https://github.com/ntd/silverstripe-carousel","last_synced_at":"2025-04-06T23:31:37.942Z","repository":{"id":20951510,"uuid":"24240047","full_name":"ntd/silverstripe-carousel","owner":"ntd","description":"A new page type that implements a carousel","archived":false,"fork":false,"pushed_at":"2021-07-08T12:48:46.000Z","size":47,"stargazers_count":3,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-22T09:01:56.355Z","etag":null,"topics":["carousel","module","silverstripe","silverstripe-module"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ntd.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-09-19T18:05:49.000Z","updated_at":"2024-07-23T08:26:35.000Z","dependencies_parsed_at":"2022-08-30T21:31:17.312Z","dependency_job_id":null,"html_url":"https://github.com/ntd/silverstripe-carousel","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ntd%2Fsilverstripe-carousel","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ntd%2Fsilverstripe-carousel/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ntd%2Fsilverstripe-carousel/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ntd%2Fsilverstripe-carousel/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ntd","download_url":"https://codeload.github.com/ntd/silverstripe-carousel/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247569123,"owners_count":20959758,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["carousel","module","silverstripe","silverstripe-module"],"created_at":"2024-11-06T01:05:33.814Z","updated_at":"2025-04-06T23:31:32.933Z","avatar_url":"https://github.com/ntd.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"Silverstripe Carousel\n=====================\n[![Code Quality](https://scrutinizer-ci.com/g/ntd/silverstripe-carousel/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/ntd/silverstripe-carousel/?branch=master)\n[![Latest Stable Version](https://poser.pugx.org/entidi/silverstripe-carousel/v/stable)](https://packagist.org/packages/entidi/silverstripe-carousel)\n\n\nIt implements a new page type (_CarouselPage_) that provides everything\nneeded to manage a carousel of images. Differently from other carousels,\nthis one does not have the concept of seats (or slots), so managing the\nimages is **much** easier on the backend side.\n\nYou can do bulk uploads and reorder the images by dragging and dropping\ntheir thumbnails in a dedicated tab (_Image list_) inside the CMS. The\nsame image can be shared among multiple carousels. This module adds also\nsome field to the _Settings_ tab, allowing the customization of some\naspect of the carousel on a per page basis (e.g., width and height of\nthe images and a flag to show or hide captions). Support for the\n[translatable](https://github.com/silverstripe/silverstripe-translatable)\nmodule is provided out of the box, i.e. when creating a translation,\nthe new page will borrow the original carousel images.\n\nTo improve file organization, if you upload your images from the\ncarousel a specific folder is pre-selected (it it exists!) instead of\nthe fallback one (`Uploads`). The folder name depends on the class\nhierarchy. If, for example, you inherit your `HomePage` type from\n`CarouselPage`, the code will look for any `Home` or `Carousel` folder\n(in this order) under your assets directory.\n\nInstallation\n------------\n\nThe feature of reordering with drag and drop is provided by the\n[sortablefile](https://github.com/bummzack/sortablefile) module that\n*must* be installed before.\n\nTo install silverstripe-carousel itself you should proceed as usual:\ndrop the directory tree in your SilverStripe root and do a\n`/dev/build/`. You will gain the new `CarouselPage` type in the CMS.\n\nIf you use [composer](https://getcomposer.org/), the dependencies will\nbe pulled-in automatically, so you could just run the following command:\n\n    composer require entidi/silverstripe-carousel\n\nUsage\n-----\n\nThis module is front end agnostic, that is you can use the javascript\nlibrary you prefer by writing a proper template.\n\nOut of the box there are a couple of templates inside `Includes` that\nimplement a [Bootstrap](http://getbootstrap.com/javascript/#carousel)\n(`ContentCarousel_bootstrap.ss`) or a [bxSlider](http://bxslider.com/)\n(`ContentCarousel_bxslider.ss`) carousel.\n\nYou can include one of them in any place inside your page template, e.g.\na basic Bootstrap layout template could look like this one:\n\n    \u003c%-- Layout/CarouselPage.ss --%\u003e\n    \u003cdiv class=\"page-header\"\u003e\n        \u003ch1\u003e$Title\u003c/h1\u003e\n    \u003c/div\u003e\n    \u003c% include ContentCarousel_bootstrap.ss %\u003e\n    \u003cdiv class=\"row typography\"\u003e\n        $Content\n    \u003c/div\u003e\n\n    \u003c%-- Include Bootstrap 3 --%\u003e\n    \u003c% require CSS(\"//cdn.jsdelivr.net/bootstrap/3/css/bootstrap.min.css\") %\u003e\n    \u003cscript type=\"text/javascript\" src=\"//cdn.jsdelivr.net/g/jquery@1,bootstrap@3\"\u003e\u003c/script\u003e\n\n    \u003c%-- Enable the carousel --%\u003e\n    \u003cscript type=\"text/javascript\"\u003e\n        \\$(document).ready(function() {\n            \\$('#ss-carousel').carousel();\n        });\n    \u003c/script\u003e\n\nThe default layout (`CarouselPage.ss`) embeds a _bxSlider_ carousel.\n\nAlternatively, the [silverstrap](http://dev.entidi.com/p/silverstrap/)\ntheme already supports this module out of the box. If you intend to\nleverage _Bootstrap_, consider using this theme instead, either by\noverriding or by modifying it.\n\n### Image captions\n\nHTML captions are allowed. This is internally done by leveraging the\n`Content` field of the `File` table (typically empty). This is supposed\nto be an HTML chunk despite being defined as a plain text field by the\nSilverStripe code.\n\nIf the captions are enabled, they can be edited directly inside the\n_Image list_ tab by clicking the _Edit_ button.\n\nWhen `Content` is not defined, an `\u003ch4\u003e` element with the image title is\nused instead: see `templates/Includes/ImageCaption.ss` for details.\n\nSupport\n-------\n\nThis project has been developed by [ntd](mailto:ntd@entidi.it). Its\n[home page](http://silverstripe.entidi.com/) is shared by other\n[SilverStripe](http://www.silverstripe.org/) modules and themes.\n\nTo check out the code, report issues or propose enhancements, go to the\n[dedicated tracker](http://dev.entidi.com/p/silverstripe-carousel).\nAlternatively, you can do the same things by leveraging the official\n[github repository](https://github.com/ntd/silverstripe-carousel).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fntd%2Fsilverstripe-carousel","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fntd%2Fsilverstripe-carousel","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fntd%2Fsilverstripe-carousel/lists"}