Skip to content

Commit 88307f9

Browse files
authored
license & doc update (#2197)
1 parent 87455f8 commit 88307f9

File tree

4 files changed

+22
-29
lines changed

4 files changed

+22
-29
lines changed

LICENSE_README renamed to LICENSE

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,6 @@
1-
v4+ Copyright (c) 2021 Alain Dumesny
2-
under MIT license
1+
MIT License
32

4-
previous v3.x and older is:
5-
/**
6-
* https://gridstackjs.com/
7-
* (c) 2014-2020 Alain Dumesny, Dylan Weiss, Pavel Reznikov
8-
* gridstack.js may be freely distributed under the MIT license.
9-
*/
10-
11-
The MIT License (MIT)
3+
Copyright (c) 2019-2023 Alain Dumesny. v0.4.0 and older (c) 2014-2018 Pavel Reznikov, Dylan Weiss
124

135
Permission is hereby granted, free of charge, to any person obtaining a copy
146
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,13 @@ Join us on Slack: https://gridstackjs.slack.com
2828
- [Include](#include)
2929
- [Basic usage](#basic-usage)
3030
- [Requirements](#requirements)
31+
- [Specific frameworks](#specific-frameworks)
3132
- [Extend Library](#extend-library)
3233
- [Extend Engine](#extend-engine)
3334
- [Change grid columns](#change-grid-columns)
3435
- [Custom columns CSS](#custom-columns-css)
3536
- [Override resizable/draggable options](#override-resizabledraggable-options)
3637
- [Touch devices support](#touch-devices-support)
37-
- [gridstack.js for specific frameworks](#gridstackjs-for-specific-frameworks)
3838
- [Migrating](#migrating)
3939
- [Migrating to v0.6](#migrating-to-v06)
4040
- [Migrating to v1](#migrating-to-v1)
@@ -142,6 +142,20 @@ see [jsfiddle sample](https://jsfiddle.net/adumesny/jqhkry7g) as running example
142142

143143
GridStack no longer requires external dependencies as of v1.0.0 (lodash was removed in v0.5.0 and jquery API in v1.0.0). v3 is a complete HTML5 re-write removing need for jquery (still available for legacy apps). v6 is native mouse and touch event for mobile support, and no longer have jquery-ui version. All you need to include now is `gridstack-all.js` and `gridstack.min.css` (layouts are done using CSS column based %).
144144

145+
## Specific frameworks
146+
147+
search for ['gridstack' under NPM](https://www.npmjs.com/search?q=gridstack&ranking=popularity) for latest, more to come...
148+
149+
- **Angular**: we now ship out of the box with Angular wrapper components - see <a href="https://github.com/gridstack/gridstack.js/tree/master/demo/angular/src/app" target="_blank">Angular Demo</a>.
150+
- **Angular9**: [lb-gridstack](https://github.com/pfms84/lb-gridstack) Note: very old v0.3 gridstack instance so recommend for **concept ONLY if you wish to use directive instead**.
151+
- **AngularJS**: [gridstack-angular](https://github.com/kdietrich/gridstack-angular)
152+
- **Ember**: [ember-gridstack](https://github.com/yahoo/ember-gridstack)
153+
- **knockout**: see [demo](https://gridstackjs.com/demo/knockout.html) using component, but check [custom bindings ticket](https://github.com/gridstack/gridstack.js/issues/465) which is likely better approach.
154+
- **Rails**: [gridstack-js-rails](https://github.com/randoum/gridstack-js-rails)
155+
- **React**: see [demo](https://gridstackjs.com/demo/react.html) with [src](https://github.com/gridstack/gridstack.js/tree/master/demo/react.html), or [react-gridstack-example](https://github.com/Inder2108/react-gridstack-example/tree/master/src/App.js), or read on what [hooks to use](https://github.com/gridstack/gridstack.js/issues/735#issuecomment-329888796)
156+
- **Vue**: see [demo](https://gridstackjs.com/demo/vue3js.html) with [v3 src](https://github.com/gridstack/gridstack.js/tree/master/demo/vue3js.html) or [v2 src](https://github.com/gridstack/gridstack.js/tree/master/demo/vue2js.html)
157+
- **Aurelia**: [aurelia-gridstack](https://github.com/aurelia-ui-toolkits/aurelia-gridstack), see [demo](https://aurelia-ui-toolkits.github.io/aurelia-gridstack/)
158+
145159
## Extend Library
146160

147161
You can easily extend or patch gridstack with code like this:
@@ -289,20 +303,6 @@ GridStack.init(options);
289303

290304
See [example](http://gridstack.github.io/gridstack.js/demo/mobile.html).
291305

292-
# gridstack.js for specific frameworks
293-
294-
search for ['gridstack' under NPM](https://www.npmjs.com/search?q=gridstack&ranking=popularity) for latest, more to come...
295-
296-
- **Angular**: we now ship out of the box with Angular wrapper components - see <a href="https://github.com/gridstack/gridstack.js/tree/master/demo/angular/src/app" target="_blank">Angular Demo</a>.
297-
- **Angular9**: [lb-gridstack](https://github.com/pfms84/lb-gridstack) Note: very old v0.3 gridstack instance so recommend for **concept ONLY if you wish to use directive instead**.
298-
- **AngularJS**: [gridstack-angular](https://github.com/kdietrich/gridstack-angular)
299-
- **Ember**: [ember-gridstack](https://github.com/yahoo/ember-gridstack)
300-
- **knockout**: see [demo](https://gridstackjs.com/demo/knockout.html) using component, but check [custom bindings ticket](https://github.com/gridstack/gridstack.js/issues/465) which is likely better approach.
301-
- **Rails**: [gridstack-js-rails](https://github.com/randoum/gridstack-js-rails)
302-
- **React**: see [demo](https://gridstackjs.com/demo/react.html) with [src](https://github.com/gridstack/gridstack.js/tree/master/demo/react.html), or [react-gridstack-example](https://github.com/Inder2108/react-gridstack-example/tree/master/src/App.js), or read on what [hooks to use](https://github.com/gridstack/gridstack.js/issues/735#issuecomment-329888796)
303-
- **Vue**: see [demo](https://gridstackjs.com/demo/vue3js.html) with [v3 src](https://github.com/gridstack/gridstack.js/tree/master/demo/vue3js.html) or [v2 src](https://github.com/gridstack/gridstack.js/tree/master/demo/vue2js.html)
304-
- **Aurelia**: [aurelia-gridstack](https://github.com/aurelia-ui-toolkits/aurelia-gridstack), see [demo](https://aurelia-ui-toolkits.github.io/aurelia-gridstack/)
305-
306306
# Migrating
307307
## Migrating to v0.6
308308

demo/angular/src/app/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ I.E. don't use Angular templating to create children as that is harder to sync.
99

1010
Code
1111

12-
```typescript
12+
```javascript
1313
import { GridStackOptions, GridStackWidget } from 'gridstack';
1414
import { GridstackComponent, nodesCB } from './gridstack.component';
1515

@@ -30,7 +30,7 @@ public onChange(data: nodesCB) {
3030
}
3131
```
3232
HTML
33-
```angular2html
33+
```html
3434
<gridstack [options]="gridOptions" (changeGS)="onChange($event)">
3535
</gridstack>
3636
```
@@ -40,7 +40,7 @@ For simple case where you control the children creation (gridstack doesn't do cr
4040

4141
Code
4242

43-
```typescript
43+
```javascript
4444
import { GridStackOptions, GridStackWidget } from 'gridstack';
4545
import { GridstackComponent, nodesCB } from './gridstack.component';
4646

@@ -66,7 +66,7 @@ public identify(index: number, w: GridStackWidget) {
6666
}
6767
```
6868
HTML
69-
```angular2html
69+
```html
7070
<gridstack [options]="gridOptions" (changeCB)="onChange($event)">
7171
<gridstack-item *ngFor="let n of items; trackBy: identify" [options]="n">
7272
Item {{n.id}}

doc/CHANGES.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ Change log
55
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
66
**Table of Contents** *generated with [DocToc](http://doctoc.herokuapp.com/)*
77

8+
- [7.2.2-dev (TBD)](#722-dev-tbd)
89
- [7.2.2 (2023-01-16)](#722-2023-01-16)
910
- [7.2.1 (2023-01-14)](#721-2023-01-14)
1011
- [7.2.0 (2023-01-07)](#720-2023-01-07)

0 commit comments

Comments
 (0)