Skip to content

Commit

Permalink
v1.2.0 realese
Browse files Browse the repository at this point in the history
1.2.0
  • Loading branch information
yoannchb-pro committed Nov 16, 2021
1 parent 88f36d1 commit 7d22f72
Show file tree
Hide file tree
Showing 29 changed files with 986 additions and 1,822 deletions.
16 changes: 8 additions & 8 deletions .babelrc
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
{
"presets": [
[
"@babel/preset-env",
{
"useBuiltIns": "entry"
}
]
"presets": [
[
"@babel/preset-env",
{
"useBuiltIns": "entry"
}
]
}
]
}
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
node_modules
package-lock.json
test
3 changes: 3 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
node_modules
test
.babelrc
1 change: 1 addition & 0 deletions .npmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
package-lock=false
6 changes: 5 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# Changelog

Changelog started on 1.1.6 because the first version was in beta
## 1.2.0
- No more .min.js or .min.css
- No more prefix `-animation` after the animation name
- Improvement for animations and lazy-attr
- Node module added

## 1.1.9
- BUGS correction
Expand Down
92 changes: 92 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
# Contributing

When contributing to this repository, please first discuss the change you wish to make via issue,
email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project.

## Pull Request Process

1. Ensure any install or build dependencies are removed before the end of the layer when doing a
build.
2. Update the README.md with details of changes to the interface, this includes new environment
variables, exposed ports, useful file locations and container parameters.
3. Increase the version numbers in any examples files and the README.md to the new version that this
Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
do not have permission to do that, you may request the second reviewer to merge it for you.

## Code of Conduct

### Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level of experience,
nationality, personal appearance, race, religion, or sexual identity and
orientation.

### Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

### Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

### Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

### Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

### Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at [http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
47 changes: 31 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,27 @@
# 📖 Lazy-attr v1.1.9
# 📖 Lazy-attr v1.2.0

[![npm](https://img.shields.io/badge/npm-download-green)](https://www.npmjs.com/package/lazy-attr) [![Download](https://img.shields.io/badge/github-download-gree)](https://github.com/yoannchb-pro/Lazy-attr)

Create lazy image, iframe, video... Make custom animation on lazy and not lazy element on all browser. You can also use our animations included in the lib ([Demo](https://yoannchb-pro.github.io/Lazy-attr/index.html#toanimate)). All of that just with html attributes.

## Browser supported

<img src="./assets/browser.png" alt="supported browser"></img>

## Example
---

```html
<img lazy-src="https://picsum.photos/300/300?random=1" lazy-srcset="https://picsum.photos/300/300?random=2 900w" lazy-animation="corner-top-left-animation" lazy-reset>
<img lazy-src="https://picsum.photos/300/300?random=1" lazy-srcset="https://picsum.photos/300/300?random=2 900w" lazy-animation="corner-top-left" lazy-reset>
```

## 🎉 Update
---

- BUGS correction
- Better animations
- `lazy-animation-pointer` can now delete the skeleton animation of an element
- No more .min.js or .min.css
- No more prefix `-animation` after the animation name
- Improvement for animations and lazy-attr
- Node module added

## 📚 Documentation & Demo
---
Expand All @@ -29,17 +34,16 @@ Create lazy image, iframe, video... Make custom animation on lazy and not lazy e
- You just need to import the css file and the js file
- In browser put it in the \<head>
- In vue.js you can put it in the public.html file
- formats : `lazy-attr.min.js`, `lazy-attr.esm.min.js` and `lazy-attr.cjs.min.js`
### CDN
```html
<script src="https://unpkg.com/lazy-attr@1.1.9/dist/lazy-attr.min.js" type="text/javascript"></script>
<link href="https://unpkg.com/lazy-attr@1.1.9/dist/lazy-attr-animation.min.css" rel="stylesheet"/>
<script src="https://unpkg.com/lazy-attr@1.2.0/dist/lazy-attr.js" type="text/javascript"></script>
<link href="https://unpkg.com/lazy-attr@1.2.0/dist/lazy-attr-animation.css" rel="stylesheet"/>
```

### From download
```html
<script src="./dist/lazy-attr.min.js" type="text/javascript" async></script>
<link href="./dist/lazy-attr-animation.min.css" rel="stylesheet"/>
<script src="./dist/lazy-attr.js" type="text/javascript"></script>
<link href="./dist/lazy-attr-animation.css" rel="stylesheet"/>
```

## Class
Expand Down Expand Up @@ -93,22 +97,20 @@ Create lazy image, iframe, video... Make custom animation on lazy and not lazy e
| version | Get actual version of lazy-attr |
| parameters | Get all possible attributes of lazy-attr |
| animations | Get all animation prefix |
| getLastVersion(callback) | Get lastversion of lazy-attr |


## Animations
---

### How
- To make an animation you need to use lazy-animation
- form: prefix-animation
- [Demo](https://yoannchb-pro.github.io/Lazy-attr/index.html#toanimate)

### Example
```html
<img lazy-src="..." lazy-srcset="..." lazy-animation="corner-top-left-animation">
<img lazy-src="..." lazy-srcset="..." lazy-animation="corner-top-left">
```

### Prefix animations list
### Animations list
```json
zoomin
zoomout
Expand All @@ -130,7 +132,7 @@ flip-up

### Create your animation
```css
.my-animation-name{
.my-name{
opacity: 0;
animation: animation-name 1s forwards;
}
Expand All @@ -140,4 +142,17 @@ flip-up
opacity: 1;
}
}
```

### Modify velocity for prebuild animations
- Work on scale and slide animations
- By default it's:
```css
:root{
--slide-start: 33%;
--slide-velocity: 7px;

--scale-velocity: 0.035;
--scale-start: 0.4;
}
```
Binary file added assets/browser.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 7d22f72

Please sign in to comment.