Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Princessb1 committed Aug 6, 2022
1 parent 6349545 commit 9ede81c
Show file tree
Hide file tree
Showing 3 changed files with 144 additions and 71 deletions.
203 changes: 133 additions & 70 deletions ReadMe.md
Original file line number Diff line number Diff line change
@@ -1,97 +1,160 @@
# Moov
Moov
Introduction
Moov is an open source library that allows beginners perform basic web animation using normal language,the Moov library allows users add animations to the websites.

## Introduction
Usage
Download the zip folder:

**Moov is an open source library that allows beginners perform basic web animation using normal language,the Moov library allows users add animations to the websites.**
CSS FILE:

<link rel="stylesheet" href="path/moov-animate.min.css">

## Usage
Download the [zip folder]():
HTML STRUCTURE:

**CSS FILE:**

`<link rel="stylesheet" href="path/moov-animate.min.css">`

**HTML STRUCTURE:**

```<div class="ds-parent">
<div class="moov-moveUp">
<div>Section 1</div>
<div>Section 2</div>
<div>Section 3</div>
</div>
</div>
```

## Example
</div>
Example
This basic code is to appply a bouceIn animation:
```

<div class="moov-bounceIn"></div>
```
To add a glow animation;
```

<div class="moov-glow"></div>
```
you can check for more usage examples on the [website](https://tallman98.github.io/Moov-Product/). - [ ]uncompleted
you can check for more usage examples on the website. - [ ]uncompleted

Contribution
If you want to contribute to this project,a pull request is the way to go and make sure to use standalized class-names.

## Contribution
If you want to contribute to this project,a pull request is the way to go and make sure to use standalized class-names.
You can view more about the Moov documentation on the website

**You can view more about the Moov documentation on the [website](https://tallman98.github.io/Moov-Product/)**
- [ ] uncompleted
uncompleted
Web App Features
Authenticated User:

1.Full access to the platform

2. Allow users download library
3. Allows users embed in their code (either by import, embed, or package manager installation)
4. The Library should allow certain animations like - move_up, move_down, move_left, blink, bounce and fade (you can add more)
5. Show usage example to users
6. Give interactive interface to generate the right combination of code to use
7. Interactive Documentation
8. Allow user save data and come back to download
uncompleted
Unauthenticated User:

## Web App Features
9. Visit the platform to view basic information about it
10. View and Interact with the documentation
11. Register to view more details
12. No access to use until registered
uncompleted
Moov is an open source library that allows beginners to perform basic web animation using everyday language, the Moov library allows users to add animations to websites.

Authenticated User:
Installation and Usage

Download from here

Import it into your file:

import ‘moov.css';

If you are using an HTML structure you can also add to As

Or add it directly to your webpage using a CDN:

Basic usage After adding or embedding the moov.css library to your code, Always ensure before calling your animation name you include “moov_animated” then the animation name.

Example This basic code is to apply a bouceIn animation:

As easy as that and you can use various types of animation provided by moov by just calling the above example
you can check for more usage examples on the website

Best Practices

Animation has a great way of calling users' attention to view your website more but it is super important you use animations in places where they are needed. There are some basic rules to follow so you stay on track while using any animation library.

Good usage of animations A component shouldn't be animated merely in order to create animation. Take into consideration that movements ought to be explicit in their intentions. Instead of just adding "flashiness" to your interface, movements including exhibitionists (bounce, blink, etc.) should be utilized to draw the attention of the user to anything exceptional in it.

Use exit and entry movements to point out exactly what is occurring in the interaction and make it evident when it is changing states.

It really doesn't indicate you shouldn't add some humor to the experience; merely make doubly sure that the audience isn't hindered by movements, but also that their excessive utilization won't slow down the piece's speed.

Bad usage of animations Resist it considering that it won't be really beneficial to the individual and likely will simply lead to instability. Additionally, there's a significant likelihood that perhaps the movements will be subpar, which will result in a poor user experience.

Although it is conceivable, you should refrain from animating the html or body tags. There have been some reports that suggest this can result in strange browser issues. Furthermore, making the entire page bounce wouldn't do much for your user experience. If you actually require this effect, wrap your page with an element and animate it instead.

Although utility classes for repeating animations, including an infinite one, are provided by moov.css, you should avoid using them. It will merely divert your users and possibly irritate a sizable portion of them. Use it accordingly.

The CSS property animation-fill-mode, which regulates an element's states before and after animation, is a component of every Moov.css animation. Learn more about it by visiting this page. The animation-fill-mode setting in Moov.css is both by default, but you can modify it to meet your specific requirements.

Some usage that can’t be avoided Despite the fact that some browsers support inline animation, doing so violates the CSS animation specifications and will eventually malfunction or stop working on some browsers. Always animate items at the block or inline-block level (grid and flex containers and children are block-level elements too). When animating an inline-level element, you can set the element to display: inline-block. The majority of Animate.css animations move elements throughout the screen and may result in scrollbars on your web application. Using the overflow: hidden property, you may control this. The basic principle is to apply it in the parent holding the animated element, but there is no set formula for when and where to use it. You must determine when and how to use it; this guide can assist you do so.

Utility Classes

A few utility classes are included with Moov.css to make use of it easier.

Delayed classes Delays can be added straight to the element's class attribute as shown here:

Try this
Moov.css provides different types of delay animations from 1s to 2s etc.
The delays offer ranges from 1s to 2s. You can alter them by adjusting the moov_delay property’s duration to a longer or shorter time frame.

/_ All delay classes will take 2x longer to start _/ :root { --moov-delay: 1s; }

/_ All delay classes will take half the time to start _/ :root { --moov-delay: 2s; }

lessons in slow, slower, fast, and faster

By including these classes, as shown below, you can modify the animation's speed:

Try this
Moov.css provides different types of fast ,faster,slow,slower animations from 1s to 2s etc.

The default speed for the moov_animated class is1s to 2s. Additionally, you can locally or globally alter the animations' duration with the - -moov-duration parameter. Both the utility classes and the animation classes will be impacted by this.

Example:

/_ All animations will take twice as long to finish _/ :root { --moov-duration: 1.2s; }

/_ Only this element will take half the time to finish _/ .my-element { --moov-duration: 800ms; }

Take note that certain animations only last a fraction of a second,using the - -moov-duration property to determine the duration will take these into account. Therefore, all animations will adjust to changes in the global duration.

Repeating Classes By including these classes, as shown below, you can manage how many times the animation is iterated: We have different repeat properties ranging from moov_repeat-1

moov_repeat-2

1.Full access to the platform
2. Allow users download library
3. Allows users embed in their code (either by import, embed, or package manager installation)
4. The Library should allow certain animations like - move_up, move_down, move_left, blink, bounce and fade (you can add more)
5. Show usage example to users
6. Give interactive interface to generate the right combination of code to use
7. Interactive Documentation
8. Allow user save data and come back to download
- [ ] uncompleted


Unauthenticated User:

1. Visit the platform to view basic information about it
2. View and Interact with the documentation
3. Register to view more details
4. No access to use until registered
- [ ] uncompleted


## Team:


Adesewa Adeboye - Product Design
Charles - Product Design
Prosper - Product Design
Hillz - Product Design
Jomex - Product Design
Kolavic - Product Design
Oluwatosin - Product Design
Peace - Product Design
Snazzyvee - Product Design
Tai_Cee - Product Design
Taofiqah - Product Design
Tessie - Product Design
Adetayo - Fullstack
Blessing Garba - Fullstack
Darhniel - Fullstack
Kenechukwu - Fullstack
Okechukwu - Fullstack
Oluwatoyin - Fullstack
Tallmantek (David)- Fullstack
Tams - Fullstack
Patrick – Frontend
moov_repeat-3

moov_infinite

The animation will be repeated twice by the element. In order to avoid a complicated situation, it is best to specify this value locally rather than globally. \*/ -- repeat-repeat: 2;

TEAM MEMBERS :

Adesewa Adeboye - Product Design
Charles - Product Design
Prosper - Product Design
Hillz - Product Design
Jomex - Product Design
Kolavic - Product Design
Oluwatosin - Product Design
Peace - Product Design
Snazzyvee - Product Design
Tai_Cee - Product Design
Taofiqah - Product Design
Tessie - Product Design
Adetayo - Fullstack
Blessing Garba - Fullstack
Darhniel - Fullstack
Kenechukwu - Fullstack
Okechukwu - Fullstack
Oluwatoyin - Fullstack
Tallmantek (David)- Fullstack
Tams - Fullstack
Patrick – Frontend
4 changes: 4 additions & 0 deletions moov_website/static/css/libraryDocumentation.css
Original file line number Diff line number Diff line change
Expand Up @@ -43,3 +43,7 @@ img {
}

/* ------------------------------------------------ GLOBAL STYLING ----------------------------------------------- */

h3 {
color: red;
}
8 changes: 7 additions & 1 deletion moov_website/templates/moov_app/library_Documentation.html
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,11 @@
href=" {% static '/css/library_Documentation.css' %} "
/>
</head>
<body></body>
<body>
<header></header>
<main>
<h3>Documentation</h3>
</main>
<footer></footer>
</body>
</html>

0 comments on commit 9ede81c

Please sign in to comment.