Skip to content
This repository has been archived by the owner on Oct 30, 2024. It is now read-only.

Commit

Permalink
move to open source license, deprecate website
Browse files Browse the repository at this point in the history
  • Loading branch information
Patrick Kunka committed Oct 25, 2024
1 parent 61dac05 commit 23d968b
Show file tree
Hide file tree
Showing 44 changed files with 1,476 additions and 103 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
Change Log
==========

## 3.3.2
- Non run-time changes to licensing and distribution model

## 3.3.1
- Insures dataset uses polyfilled `Array.from` for old IE support.
- Fixes support for sorting via element collection. This was not correctly implemented before although documented.
Expand Down
201 changes: 201 additions & 0 deletions LICENSE.txt
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "{}"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright {yyyy} {name of copyright owner}

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
71 changes: 63 additions & 8 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,30 @@
# 📣 November 2024 Update 📣

### Changes to License Model

As MixItUp turns 10 years old (and having remained unchanged since ~2018) it will be moving to a **fully open source** and publicly available model. This means that from 1st November 2024, you no longer need to purchase a license for commercial use.

Additionally, the MixItUp project and its extensions will become **fully archived** meaning that no future changes will be made. MixItUp has been stable for many years and remains in use across tens of thousands of web sites and applications worldwide. If you wish to use it on a brand-new project and it meets your needs, then you should feel confident in doing so.

### Pagination and MultiFilter Extensions

The Pagination and MultiFilter extensions, which were previously closed source and only available via purchase, have also been been made publicly available on GitHub, and may now be used without purchase or a commercial license.

- [www.github.com/patrickkunka/mixitup-pagination](https://www.github.com/patrickkunka/mixitup-pagination)
- [www.github.com/patrickkunka/mixitup-multifilter](https://www.github.com/patrickkunka/mixitup-multifilter)

### Documentation Website

The documentation website has been retired in favor of GitHub. All documentation and tutorials are available via this GitHub repository, or the repository of the relevant extension (see above).

### Demos

Hosted interactive demos may be found at [patrickkunka.github.io/mixitup/demos](https://patrickkunka.github.io/mixitup/demos). The documented source code of each demo can be found in the [/demos](./demos/) directory if this repository.

Demos for the Pagination and MultiFilter extensions can be found linked to in their respective repositories.

---

# MixItUp 3

[![Build Status](https://travis-ci.org/patrickkunka/mixitup.svg?branch=v3)](https://travis-ci.org/patrickkunka/mixitup)
Expand All @@ -8,13 +35,11 @@ MixItUp is a high-performance, dependency-free library for animated DOM manipula

MixItUp plays nice with your existing HTML and CSS, making it a great choice for responsive layouts and compatible with inline-flow, percentages, media queries, flexbox and more.

For a live sandbox, full documentation, tutorials and more, please visit [kunkalabs.com/mixitup](https://www.kunkalabs.com/mixitup/).

Migrating from MixItUp 2? Check out the [MixItUp 3 Migration Guide](./docs/mixitup-3-migration-guide.md).

#### Licensing

MixItUp is open source and free to use for non-commercial, educational and non-profit use. For use in commercial projects, **a commercial license is required**. For licensing information and FAQs please see the [MixItUp Licenses](https://www.kunkalabs.com/mixitup/licenses/) page.
MixItUp is open source and free to use for all use cases, under the Apache 2.0 license.

#### Documentation

Expand All @@ -24,6 +49,36 @@ MixItUp is open source and free to use for non-commercial, educational and non-p
- [State Object](./docs/mixitup.State.md)
- [Mixer Events](./docs/mixitup.Events.md)

#### Tutorials

##### [Integrating MixItUp into Your Project](./tutorials/integrating-mixitup-into-your-project.md)

MixItUp can be used with static sites, CMSs, web apps and more. This tutorial will help you choose the right integration for your project.

##### [Filtering with MixItUp](./tutorials/filtering-with-mixitup.md)

A summary of the various filtering techniques available in MixItUp – filter/toggle controls, multidimensional filtering, and the filter API.

##### [Sorting with MixItUp](./tutorials/sorting-with-mixitup.md)

A summary of the various sorting techniques available in MixItUp – default sort, attribute sort, multi-attribute sort, and the sort API.

##### [MixItUp Grid Layouts](./tutorials/mixitup-grid-layouts.md)

A summary of the three most common approaches to responsive grids – inline-block, flex-box, and floats – in the context of MixItUp.

##### [Marking Up MixItUp Containers](./tutorials/marking-up-mixitup-containers.md)

This tutorial explores various container markup structures, and explains what is and isn't possible with MixItUp.

##### [Filtering and Sorting on Load](./tutorials/filtering-and-sorting-on-load.md)

A look at how we can use the configuration object to load MixItUp in a state other than its default filtering and sorting behavior.

##### [Using the Dataset API](./tutorials/using-the-dataset-api.md)

New to MixItUp 3, the Dataset API allows interaction with MixItUp purely via changes to a data model, avoiding the use of DOM selectors.

#### Browser Support

MixItUp 3 has been tested for compatibility with the following browsers.
Expand Down Expand Up @@ -65,7 +120,7 @@ By default, MixItUp will query the container for targets matching the selector `

Targets can be filtered using any valid selector e.g. `'.category-a'`, and are sorted via optional custom data attributes e.g. `'data-order'`.

Further reading: [Marking-up MixItUp Containers](https://www.kunkalabs.com/tutorials/marking-up-mixitup-containers/)
Further reading: [Marking-up MixItUp Containers](./tutorials/marking-up-mixitup-containers.md)

### Building Controls

Expand All @@ -82,7 +137,7 @@ Filter controls are queried based on the presence of a `data-filter` attribute,
<button type="button" data-filter=".category-c">Category C</button>
```

Further reading: [Filtering with MixItUp](https://www.kunkalabs.com/tutorials/filtering-with-mixitup/)
Further reading: [Filtering with MixItUp](./tutorials/filtering-with-mixitup.md)

#### Sort Controls

Expand All @@ -96,13 +151,13 @@ Sort controls are queried based on the presence of a `data-sort` attribute, whos

The values `'default'` and `'random'` are also valid, with `'default'` referring to the original order of target elements in the DOM at the time of mixer instantiation.

Further reading: [Sorting with MixItUp](https://www.kunkalabs.com/tutorials/sorting-with-mixitup/)
Further reading: [Sorting with MixItUp](./tutorials/sorting-with-mixitup.md)

### Styling the Container

While MixItUp can be added on top of any existing CSS layout, we strongly recommend inline-block or flexbox-based styling over floats and legacy grid frameworks when dealing with grid-based designs for a number of reasons.

Further reading: [MixItUp Grid Layouts](https://www.kunkalabs.com/tutorials/mixitup-grid-layouts/)
Further reading: [MixItUp Grid Layouts](./tutorials/mixitup-grid-layouts.md)

### Loading MixItUp

Expand Down Expand Up @@ -205,4 +260,4 @@ Further reading: [Mixer API Methods](./docs/mixitup.Mixer.md)

You may wish to use MixItUp 3's new "dataset" API. Dataset is designed for use in API-driven JavaScript applications, and can be used instead of DOM-based methods such as `.filter()`, `.sort()`, `.insert()`, etc. When used, insertion, removal, sorting and pagination can be achieved purely via changes to your data model, without the uglyness of having to interact with or query the DOM directly.

Further reading: [Using the Dataset API](https://www.kunkalabs.com/tutorials/using-the-dataset-api/)
Further reading: [Using the Dataset API](./tutorials/using-the-dataset-api.md)
12 changes: 3 additions & 9 deletions composer.json
View file
Original file line number Diff line number Diff line change
@@ -1,19 +1,13 @@
{
"name": "patrickkunka/mixitup",
"type": "library",
"homepage": "https://www.kunkalabs.com/mixitup/",
"license": [
"proprietary"
],
"homepage": "https://github.com/patrickkunka/mixitup/",
"license": "Apache-2.0",
"authors": [
{
"name": "KunkaLabs Limited",
"homepage": "https://www.kunkalabs.com/"
"name": "KunkaLabs Limited"
}
],
"support": {
"docs": "https://www.kunkalabs.com/mixitup/docs/get-started/"
},
"description": "A high-performance, dependency-free library for animated filtering, sorting and more",
"keywords": ["javascript", "animate", "filtering", "sorting"]
}
2 changes: 1 addition & 1 deletion demos/attribute-selectors/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
<div class="gap"></div>
</div>

<script src="../mixitup.min.js"></script>
<script src="../../dist/mixitup.min.js"></script>

<script>
var containerEl = document.querySelector('[data-ref~="mixitup-container"]');
Expand Down
2 changes: 1 addition & 1 deletion demos/basic-ie-8/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
<div class="gap"></div>
</div>

<script src="../mixitup.min.js"></script>
<script src="../../dist/mixitup.min.js"></script>

<script>
var containerEl = document.querySelector('.container');
Expand Down
Loading

0 comments on commit 23d968b

Please sign in to comment.