Clockvine is a JavaScript library that provides some CRUD-like functionality for elements and collections on top of a JSON-based API. Currently it supports RESTful JSON endpoints, such as those provided by craftcms/element-api or easily built with Laravel's resource controllers.
There is a PHP package, imarc/clockvine, that's a middleware designed to normalize responses from Laravel to be compatible, but that library is deprecated and unnecessary.
0.4 is out of beta, but still young - we're using the existing functionality, but it hasn't quite hit the stability we'd associate with a 1.0 release. Any backwards compatibility breaks are being documented in the release notes, and we're following semver.
- Expected API
- Getting Started
- ApiModule
- ElementComponent
- CollectionComponent
- Decorated Element Methods
Clockvine provides constructors for Vuex modules, constructors for Vue components, and regular Vue components.
- ApiModule (previously vuexModule) - class used to construct Vuex modules that are backed by a RESTful API endpoint.
- ElementApiModule - subclass of ApiModule configured specifically for craftcms/element-api endpoints.
Components
- ElementComponent - used for a single element.
- CollectionComponent (previously ElementsCompononet) - used for a collection of elements.
- PaginatedCollectionComponent - subclass of CollectionComponent that is built for paginated elements.
- ContinuousCollectionComponent - subclass of CollectionComponent that is built for paginated elements displayed as a 'growing list' (Load More buttons, etc) instead of page by page.
- LiveSearch - constructs a Vue component for a live search field.
- PaginationNav - constructors a Vue component for pagination.
Mixins
- ResetsPage - Watches a data property (
params) and resets properties within it (params.page) when other properties change. - SyncsWithUrl - Syncs URL params back and forth with a data property.
- Added as commonjs built file as well.
Clockvine now builds as a ESM module, thanks to switching from Webpack to Rollup. The version produced should be much easier to use in projects where you need IE11 compatibility now.
- Change build from webpack to rollup
- Switch to standard for code formattting
- Package clockvine using purtuga/esm-webpack-plugin
- Fix critical bug with calling $update multiple times on the same element
- Fix bug with indexes
- Add support for parseResponse, a hook that can be used to make clockvine work with APIs that don't match the format clockvine expects.
- Don't use this version.
- Major cleanup to how parameters are handled within URL generation; separation into params/availableParams
- Add parseResponse configuration option
- Critical fix for debouncing functionality
- Critical fix for subsequent shows after updates
- Critical fix for PaginatedCollectionComponent
This has backwards compatibility breaks with beta.1.
- Change store and update actions to accept a payload of
{ params, data }instead of justdata. - Make sure elements are decorated even when using
no-fetching. - Add a new configuration option to ApiModules,
relatedElements, to configure decorating and updating vuex with elements that are embedded within a response. For example, child elements. - Rename ElementsComponent to CollectionComponent and related. Old names are
- deprecated but will continue to work for now.
This has backwards compatibility breaks with beta.1.
- Change store and update actions to accept a payload of
{ params, data }instead of justdata. - Make sure elements are decorated even when using
no-fetching. - Add a new configuration option to ApiModules,
relatedElements, to configure decorating and updating vuex with elements that are embedded within a response. For example, child elements. - Rename ElementsComponent to CollectionComponent and related. Old names are
- deprecated but will continue to work for now.
- Add support for passing
paramsto ElementComponent
This has backwards compatibility breaks with alpha.12.
- Fix issue so that you can
import { ElementComponent} from 'clockvine-vue'now instead of having to import the whole object every time. - Add ElementComponent.with, ElementComponent.for, ElementsComponent.with, ElementsComponent.for
- Add debouncing in between vuex events and API requests for store, update, and index calls
- Add support a pseudo template string format to LaraevlApiModule (may change more)
- Fix bug with isLoading events
- Fix bug with .store promise
- Add require-params prop
This has backwards compatibility breaks with alpha.7.
- Change implementation to decoate elements (objects) returned by clockvine with methods/properties. These include
$show,$mustShow,$update,$store,$destroy,$index,$mustIndex, and$existsfor different objects. - Add
syncsWithUrlproperty to disable URL syncing for ElementsComponent.
- Add functionality to 'clear out' data using
newElementafter triggering astore
This has backwards compatibility breaks with alpha.5.
- Rework Vue Components so they're no longer JS classes. This was necessary because there were assumptions made about how instances work that were wrong.
- Make store/update/destroy work.
- Make it so that vuex module can be passed as a param
- Add LaravelApiModule
- Bug fixes for LiveSearch and SyncsWithUrl
This has backwards compatibility breaks with alpha.2.
- Bug fixes and adopting airbnb and vue style guide conventions
- Rename nearly all classes and mixins for clarity and consistency
This has backwards compatibility breaks with 0.3.
- Read only functionality is mostly complete; tested primarily with ElementApi.
This has backwards compatibility breaks with 0.2.
- This version makes some significant internal architecture changes, switching to storing indices (collections) by URL along with individual models within Vuex.
- It also changes how urlParams should be passed, and flatted more of these params together.
- Also significant, you can provide a function to override indexUrl in vuexModules so that, based on action and params, you can use a different endpoint.
You should at least use this version, because I don't think 0.1 even worked.
- Added support for simple pagination. These changes are not available in 0.3 yet.