├── .npmignore
├── public
    ├── gif.gif
    ├── favicon.ico
    └── index.html
├── src
    ├── index.js
    ├── docs
    │   ├── components
    │   │   ├── title
    │   │   │   └── index.js
    │   │   ├── hello
    │   │   │   ├── index.css
    │   │   │   └── index.js
    │   │   ├── example3
    │   │   │   ├── index.css
    │   │   │   ├── index.js
    │   │   │   └── block.js
    │   │   ├── example1
    │   │   │   ├── index.css
    │   │   │   ├── index.js
    │   │   │   └── block.js
    │   │   ├── footer
    │   │   │   └── index.js
    │   │   ├── example2
    │   │   │   ├── index.css
    │   │   │   ├── block.js
    │   │   │   └── index.js
    │   │   ├── navbar
    │   │   │   └── index.js
    │   │   ├── methods
    │   │   │   └── index.js
    │   │   ├── usage
    │   │   │   └── index.js
    │   │   └── props
    │   │   │   └── index.js
    │   ├── App.js
    │   └── index.css
    └── react-advanced-news-ticker
    │   └── index.js
├── .gitignore
├── package.json
├── README.md
├── dist
    └── index.js
└── LICENSE


/.npmignore:
--------------------------------------------------------------------------------
1 | build
2 | docs
3 | public
4 | 


--------------------------------------------------------------------------------
/public/gif.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ahmetcanaydemir/react-advanced-news-ticker/HEAD/public/gif.gif


--------------------------------------------------------------------------------
/public/favicon.ico:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ahmetcanaydemir/react-advanced-news-ticker/HEAD/public/favicon.ico


--------------------------------------------------------------------------------
/src/index.js:
--------------------------------------------------------------------------------
 1 | import React from "react";
 2 | import ReactDOM from "react-dom";
 3 | import App from "./docs/App";
 4 | 
 5 | ReactDOM.render(
 6 |   <React.StrictMode>
 7 |     <App />
 8 |   </React.StrictMode>,
 9 |   document.getElementById("root")
10 | );
11 | 


--------------------------------------------------------------------------------
/src/docs/components/title/index.js:
--------------------------------------------------------------------------------
 1 | import React from "react";
 2 | 
 3 | function Title({ title, id }) {
 4 |   return (
 5 |     <div className="bg-dark text-light text-center py-4 " id={id}>
 6 |       <h2>{title}</h2>
 7 |     </div>
 8 |   );
 9 | }
10 | 
11 | export default Title;
12 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | # dependencies
 2 | node_modules
 3 | 
 4 | # production
 5 | build
 6 | 
 7 | # misc
 8 | .DS_Store
 9 | .env.local
10 | .env.development.local
11 | .env.test.local
12 | .env.production.local
13 | 
14 | npm-debug.log*
15 | yarn-debug.log*
16 | yarn-error.log*
17 | package-lock.json
18 | 


--------------------------------------------------------------------------------
/src/docs/components/hello/index.css:
--------------------------------------------------------------------------------
 1 | /* hello */
 2 | #hello {
 3 |   width: 100%;
 4 |   padding-top: 150px;
 5 |   padding-bottom: 150px;
 6 | }
 7 | 
 8 | #hello h1 {
 9 |   font-size: 45px;
10 |   font-weight: 600;
11 |   color: #319795;
12 | }
13 | 
14 | #hello h2 {
15 |   color: #c0c0c0;
16 |   font-weight: 400;
17 | }
18 | 
19 | /* nt-title */
20 | 
21 | #nt-title li {
22 |   list-style: none;
23 | }
24 | #nt-title li div {
25 |   font-size: 28px;
26 |   color: #4e4e4e;
27 |   white-space: nowrap;
28 |   overflow: hidden;
29 |   text-overflow: ellipsis;
30 | }
31 | 


--------------------------------------------------------------------------------
/src/docs/components/example3/index.css:
--------------------------------------------------------------------------------
 1 | /* nt-example3 */
 2 | 
 3 | #nt-example3 {
 4 |   margin: 80px auto 0;
 5 | }
 6 | 
 7 | #nt-example3-container {
 8 |   text-align: center;
 9 | }
10 | 
11 | #nt-example3-container i {
12 |   font-size: 36px;
13 |   margin: 8px;
14 |   cursor: pointer;
15 |   -webkit-transition: all 0.1s ease-in-out;
16 |   -moz-transition: all 0.1s ease-in-out;
17 |   -ms-transition: all 0.1s ease-in-out;
18 |   -o-transition: all 0.1s ease-in-out;
19 |   transition: all 0.1s ease-in-out;
20 | }
21 | 
22 | #nt-example3-container i:hover {
23 |   color: #333;
24 | }
25 | 
26 | #nt-example3 li {
27 |   color: #4e4e4e;
28 |   background: #f2f2f2;
29 |   overflow: hidden;
30 |   height: 80px;
31 |   padding: 10px;
32 |   line-height: 60px;
33 |   font-size: 40px;
34 |   text-transform: uppercase;
35 |   list-style: none;
36 | }
37 | 
38 | #nt-example3 li:hover {
39 |   background: #fff;
40 | }
41 | 


--------------------------------------------------------------------------------
/src/docs/App.js:
--------------------------------------------------------------------------------
 1 | import React from "react";
 2 | import Example1Block from "./components/example1/block";
 3 | import Example2Block from "./components/example2/block";
 4 | import Example3Block from "./components/example3/block";
 5 | import Footer from "./components/footer";
 6 | import Hello from "./components/hello";
 7 | import NavBar from "./components/navbar";
 8 | import Usage from "./components/usage";
 9 | import "codemirror/keymap/sublime";
10 | import "codemirror/theme/monokai.css";
11 | import "./index.css";
12 | import Methods from "./components/methods";
13 | import Props from "./components/props";
14 | 
15 | function App() {
16 |   return (
17 |     <>
18 |       <NavBar />
19 |       <Hello />
20 |       <Example1Block />
21 |       <Example2Block />
22 |       <Example3Block />
23 |       <Usage />
24 |       <Props />
25 |       <Methods />
26 |       <Footer />
27 |     </>
28 |   );
29 | }
30 | 
31 | export default App;
32 | 


--------------------------------------------------------------------------------
/src/docs/components/example1/index.css:
--------------------------------------------------------------------------------
 1 | /* nt-example1 */
 2 | 
 3 | #nt-example1 {
 4 |   max-width: 620px;
 5 |   margin: auto;
 6 | }
 7 | 
 8 | #nt-example1-container {
 9 |   text-align: center;
10 | }
11 | 
12 | #nt-example1-container i {
13 |   font-size: 36px;
14 |   margin: 8px;
15 |   cursor: pointer;
16 |   -webkit-transition: all 0.1s ease-in-out;
17 |   -moz-transition: all 0.1s ease-in-out;
18 |   -ms-transition: all 0.1s ease-in-out;
19 |   -o-transition: all 0.1s ease-in-out;
20 |   transition: all 0.1s ease-in-out;
21 | }
22 | 
23 | #nt-example1-container i:hover {
24 |   color: #333;
25 | }
26 | 
27 | #nt-example1 li {
28 |   color: #4e4e4e;
29 |   background: #f2f2f2;
30 |   overflow: hidden;
31 |   height: 80px;
32 |   padding: 10px;
33 |   line-height: 30px;
34 |   list-style: none;
35 |   font-size: 24px;
36 |   text-align: left;
37 |   border-bottom: 1px dotted #2c8162;
38 | }
39 | 
40 | #nt-example1 li:hover {
41 |   background: #fff;
42 | }
43 | 


--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "react-advanced-news-ticker",
 3 |   "version": "1.0.1",
 4 |   "main": "dist/index.js",
 5 |   "scripts": {
 6 |     "start": "react-scripts start",
 7 |     "build:docs": "react-scripts build",
 8 |     "build": "SET NODE_ENV=production && rm -rf dist && mkdir dist && npx babel src/react-advanced-news-ticker --out-dir dist --copy-files",
 9 |     "predeploy": "npm run build:docs",
10 |     "deploy": "gh-pages -b gh-pages -d build"
11 |   },
12 |   "license": "GPL-2.0",
13 |   "repository": {
14 |     "type": "git",
15 |     "url": "https://github.com/ahmetcanaydemir/react-advanced-news-ticker"
16 |   },
17 |   "homepage": "http://ahmetcanaydemir.github.io/react-advanced-news-ticker/",
18 |   "dependencies": {
19 |     "prop-types": "^15.7.2",
20 |     "react": "^16.13.1"
21 |   },
22 |   "devDependencies": {
23 |     "@uiw/react-codemirror": "^3.0.1",
24 |     "babel-cli": "^6.26.0",
25 |     "babel-preset-env": "^1.7.0",
26 |     "babel-preset-react": "^6.24.1",
27 |     "gh-pages": "^3.1.0",
28 |     "react-dom": "^16.13.1",
29 |     "react-scripts": "3.4.3"
30 |   },
31 |   "eslintConfig": {
32 |     "extends": "react-app"
33 |   },
34 |   "browserslist": {
35 |     "production": [
36 |       ">0.2%",
37 |       "not dead",
38 |       "not op_mini all"
39 |     ],
40 |     "development": [
41 |       "last 1 chrome version",
42 |       "last 1 firefox version",
43 |       "last 1 safari version"
44 |     ]
45 |   },
46 |   "module": "dist/index.js",
47 |   "babel": {
48 |     "presets": [
49 |       "react",
50 |       "env"
51 |     ]
52 |   }
53 | }
54 | 


--------------------------------------------------------------------------------
/src/docs/index.css:
--------------------------------------------------------------------------------
 1 | html {
 2 |   scroll-behavior: smooth;
 3 | }
 4 | 
 5 | body {
 6 |   font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji",
 7 |     "Segoe UI Emoji", "Segoe UI Symbol";
 8 | }
 9 | 
10 | ul {
11 |   padding: 0;
12 | }
13 | 
14 | .button {
15 |   padding: 16px 30px;
16 |   cursor: pointer;
17 |   margin-bottom: 0;
18 |   font-size: 18px;
19 |   background: #319795;
20 |   color: #fff;
21 |   display: inline-block;
22 |   border-radius: none;
23 |   border-radius: 4px;
24 | }
25 | 
26 | .button:hover {
27 |   background-color: #2c7a7b;
28 | }
29 | 
30 | .colored-block {
31 |   background-color: #319795;
32 | }
33 | 
34 | /* TABLE */
35 | .params-table code {
36 |   color: #4e4e4e;
37 |   border-radius: 1px;
38 |   background-color: rgba(116, 207, 174, 0.3);
39 |   -webkit-transition: background-color 0.1s ease-in-out;
40 |   -moz-transition: background-color 0.1s ease-in-out;
41 |   -ms-transition: background-color 0.1s ease-in-out;
42 |   -o-transition: background-colorl 0.1s ease-in-out;
43 |   transition: background-color 0.1s ease-in-out;
44 | }
45 | 
46 | .params-table code:hover {
47 |   background-color: rgba(116, 207, 174, 0.5);
48 | }
49 | 
50 | .params-table thead {
51 |   color: #fff;
52 |   background-color: #2c7a7b;
53 | }
54 | 
55 | .params-table thead > tr > th {
56 |   border-bottom: none;
57 |   font-size: 1.2em;
58 |   font-weight: 300;
59 |   text-transform: uppercase;
60 | }
61 | 
62 | .params-table tbody > tr > td {
63 |   border-top: none;
64 | }
65 | 
66 | .params-table > tbody > tr:hover > td {
67 |   background-color: #e4f6ef;
68 | }
69 | 


--------------------------------------------------------------------------------
/src/docs/components/example1/index.js:
--------------------------------------------------------------------------------
 1 | import React, { useRef } from "react";
 2 | import NewsTicker, { Directions } from "../../../react-advanced-news-ticker/";
 3 | import "./index.css";
 4 | 
 5 | function Example1() {
 6 |   const ref = useRef(null);
 7 |   return (
 8 |     <div id="nt-example1-container">
 9 |       <i
10 |         className="fa fa-arrow-up"
11 |         id="nt-example1-prev"
12 |         onClick={() => {
13 |           ref.current.movePrev();
14 |           ref.current.resetInterval();
15 |         }}
16 |       />
17 |       <NewsTicker ref={ref} id="nt-example1" direction={Directions.UP} rowHeight={80} maxRows={3} duration={4000}>
18 |         <div>
19 |           Maecenas nec ligula sed est suscipit aliquet sed eget ipsum, suspendisse.{" "}
20 |           <span className="text-primary">Read more...</span>
21 |         </div>
22 |         <div>
23 |           Etiam imperdiet volutpat libero eu tristique. Aenean, rutrum felis in.{" "}
24 |           <span className="text-primary">Read more...</span>
25 |         </div>
26 |         <div>
27 |           Praesent ornare nisl lorem, ut condimentum lectus gravida ut.{" "}
28 |           <span className="text-primary">Read more...</span>
29 |         </div>
30 |         <div>
31 |           In pharetra suscipit orci sed viverra. Praesent at sollicitudin tortor, id.{" "}
32 |           <span className="text-primary">Read more...</span>
33 |         </div>
34 |       </NewsTicker>
35 |       <i
36 |         className="fa fa-arrow-down"
37 |         id="nt-example1-next"
38 |         onClick={() => {
39 |           ref.current.moveNext();
40 |           ref.current.resetInterval();
41 |         }}
42 |       />
43 |     </div>
44 |   );
45 | }
46 | 
47 | export default Example1;
48 | 


--------------------------------------------------------------------------------
/public/index.html:
--------------------------------------------------------------------------------
 1 | <!DOCTYPE html>
 2 | <html lang="en">
 3 |   <head>
 4 |     <meta charset="utf-8" />
 5 |     <link rel="icon" href="%PUBLIC_URL%/favicon.ico" />
 6 |     <meta name="viewport" content="width=device-width, initial-scale=1" />
 7 |     <meta name="description" content="Web site created using create-react-app" />
 8 |     <link
 9 |       rel="stylesheet"
10 |       href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.14.0/css/all.min.css"
11 |       integrity="sha512-1PKOgIY59xJ8Co8+NE6FZ+LOAZKjy+KY8iq0G4B3CyeY6wYHN3yt9PW0XpSriVlkMXe40PTKnXrLnZ9+fkDaog=="
12 |       crossorigin="anonymous"
13 |     />
14 |     <link
15 |       rel="stylesheet"
16 |       href="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/css/bootstrap.min.css"
17 |       integrity="sha384-JcKb8q3iqJ61gNV9KGb8thSsNjpSL0n8PARn9HuZOnIxN0hoP+VmmDGMN5t9UJ0Z"
18 |       crossorigin="anonymous"
19 |     />
20 | 
21 |     <title>React Advanced News Ticker - Ahmet Can Aydemir</title>
22 |   </head>
23 |   <body data-spy="scroll" data-target="#navbar" data-offset="70">
24 |     <noscript>You need to enable JavaScript to run this app.</noscript>
25 |     <div id="root"></div>
26 |     <script
27 |       src="https://code.jquery.com/jquery-3.5.1.slim.min.js"
28 |       integrity="sha384-DfXdz2htPH0lsSSs5nCTpuj/zy4C+OGpamoFVy38MVBnE+IbbVYUew+OrCXaRkfj"
29 |       crossorigin="anonymous"
30 |     ></script>
31 |     <script
32 |       src="https://cdn.jsdelivr.net/npm/popper.js@1.16.1/dist/umd/popper.min.js"
33 |       integrity="sha384-9/reFTGAW83EW2RDu2S0VKaIzap3H66lZH81PoYlFhbGU+6BZp6G7niu735Sk7lN"
34 |       crossorigin="anonymous"
35 |     ></script>
36 |     <script
37 |       src="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/js/bootstrap.min.js"
38 |       integrity="sha384-B4gt1jrGC7Jh4AgTPSdUtOBvfO8shuf57BaghqFfPlYxofvL8/KUEfYiJOMMV+rV"
39 |       crossorigin="anonymous"
40 |     ></script>
41 |   </body>
42 | </html>
43 | 


--------------------------------------------------------------------------------
/src/docs/components/footer/index.js:
--------------------------------------------------------------------------------
 1 | import React from "react";
 2 | 
 3 | function Footer() {
 4 |   return (
 5 |     <div
 6 |       className="d-flex flex-column justify-content-center align-items-center"
 7 |       style={{ paddingTop: 50, paddingBottom: 50, fontSize: 14 }}>
 8 |       <div>
 9 |         Developed by <a href="https://www.ahmetcanaydemir.com">Ahmet Can Aydemir</a>
10 |       </div>
11 |       <div className="mt-2">
12 |         Based on <a href="https://github.com/risq">risq</a>'s{" "}
13 |         <a href="https://github.com/risq/jquery-advanced-news-ticker">JQuery Advanced News Ticker</a>
14 |       </div>
15 |       <div className=" mt-3 d-flex justify-content-between" style={{ fontSize: 20, width: 120 }}>
16 |         <a
17 |           target="_blank"
18 |           rel="noopener noreferrer"
19 |           className="text-decoration-none text-secondary"
20 |           href="https://www.github.com/ahmetcanaydemir">
21 |           <i className="fab fa-github"></i>
22 |         </a>
23 |         <a
24 |           target="_blank"
25 |           rel="noopener noreferrer"
26 |           className="text-decoration-none text-secondary"
27 |           href="https://www.twitter.com/ahmetcnaydemir">
28 |           <i className="fab fa-twitter"></i>
29 |         </a>
30 |         <a
31 |           target="_blank"
32 |           rel="noopener noreferrer"
33 |           className="text-decoration-none text-secondary"
34 |           href="https://www.linkedin.com/in/ahmetcanaydemir">
35 |           <i className="fab fa-linkedin"></i>
36 |         </a>
37 |         <a
38 |           target="_blank"
39 |           rel="noopener noreferrer"
40 |           className="text-decoration-none text-secondary"
41 |           href="mailto:root@ahmetcanaydemir.com">
42 |           <i className="fas fa-envelope"></i>
43 |         </a>
44 |       </div>
45 |     </div>
46 |   );
47 | }
48 | 
49 | export default Footer;
50 | 


--------------------------------------------------------------------------------
/src/docs/components/example2/index.css:
--------------------------------------------------------------------------------
 1 | /* nt-example2 */
 2 | 
 3 | #nt-example2 {
 4 |   max-width: 620px;
 5 |   margin: auto;
 6 | }
 7 | 
 8 | #nt-example2-container {
 9 |   text-align: center;
10 |   margin-top: 107px;
11 |   margin-bottom: 40px;
12 |   height: 300px;
13 | }
14 | 
15 | #nt-example2-container i {
16 |   font-size: 24px;
17 |   margin: 8px;
18 |   cursor: pointer;
19 |   -webkit-transition: all 0.1s ease-in-out;
20 |   -moz-transition: all 0.1s ease-in-out;
21 |   -ms-transition: all 0.1s ease-in-out;
22 |   -o-transition: all 0.1s ease-in-out;
23 |   transition: all 0.1s ease-in-out;
24 | }
25 | 
26 | #nt-example2-container i:hover {
27 |   color: #333;
28 | }
29 | 
30 | #nt-example2 li {
31 |   color: #f2f2f2;
32 |   background: #319795;
33 |   white-space: nowrap;
34 |   overflow: hidden;
35 |   text-overflow: ellipsis;
36 |   height: 60px;
37 |   padding: 10px 16px 10px 16px;
38 |   line-height: 40px;
39 |   list-style: none;
40 |   font-size: 24px;
41 |   text-align: left;
42 | }
43 | 
44 | #nt-example2 li div {
45 |   white-space: nowrap;
46 |   overflow: hidden;
47 |   text-overflow: ellipsis;
48 | }
49 | 
50 | #nt-example2 li div .state {
51 |   font-size: inherit;
52 |   margin: 0;
53 | }
54 | 
55 | #nt-example2 span.hour {
56 |   font-weight: 700;
57 | }
58 | 
59 | #nt-example2-infos-triangle {
60 |   width: 0px;
61 |   height: 0px;
62 |   border-style: solid;
63 |   border-width: 0 15px 16px 15px;
64 |   border-color: transparent transparent #319795 transparent;
65 |   margin: 6px auto 0;
66 | }
67 | 
68 | #nt-example2-infos {
69 |   max-width: 620px;
70 |   margin: auto;
71 |   padding: 12px;
72 |   color: #f2f2f2;
73 |   background: #319795;
74 | }
75 | 
76 | #nt-example2-infos .infos-hour {
77 |   font-size: 32px;
78 |   font-weight: 700;
79 |   margin-top: 20px;
80 | }
81 | 
82 | #nt-example2-infos h4 {
83 |   color: #f2f2f2;
84 |   font-weight: 500;
85 | }
86 | 
87 | #nt-example2-infos .infos-text {
88 |   text-align: left;
89 |   overflow: hidden;
90 |   text-overflow: ellipsis;
91 | }
92 | 


--------------------------------------------------------------------------------
/src/docs/components/navbar/index.js:
--------------------------------------------------------------------------------
 1 | import React from "react";
 2 | 
 3 | function NavBar() {
 4 |   return (
 5 |     <nav id="navbar" className="bg-white border-bottom sticky-top navbar navbar-expand-lg navbar-light">
 6 |       <div className="container">
 7 |         <button
 8 |           className="navbar-toggler"
 9 |           type="button"
10 |           data-toggle="collapse"
11 |           data-target="#navbarText"
12 |           aria-controls="navbarText"
13 |           aria-expanded="false"
14 |           aria-label="Toggle navigation">
15 |           <span className="navbar-toggler-icon"></span>
16 |         </button>
17 |         <div className="collapse navbar-collapse" id="navbarText">
18 |           <ul className="navbar-nav mr-auto">
19 |             <li className="nav-item ">
20 |               {
21 |                 // eslint-disable-next-line
22 |               }
23 |               <a className="nav-link" href="#">
24 |                 Home <span className="sr-only">(current)</span>
25 |               </a>
26 |             </li>
27 |             <li className="nav-item">
28 |               <a className="nav-link" href="#examples">
29 |                 Examples
30 |               </a>
31 |             </li>
32 |             <li className="nav-item">
33 |               <a className="nav-link" href="#usage">
34 |                 Usage
35 |               </a>
36 |             </li>
37 |             <li className="nav-item">
38 |               <a className="nav-link" href="#props">
39 |                 Props
40 |               </a>
41 |             </li>
42 |             <li className="nav-item">
43 |               <a className="nav-link" href="#methods">
44 |                 Methods
45 |               </a>
46 |             </li>
47 |           </ul>
48 |           <span className="navbar-text" style={{ fontSize: 24 }}>
49 |             <a
50 |               target="_blank"
51 |               rel="noopener noreferrer"
52 |               className="text-decoration-none text-secondary"
53 |               href="https://www.github.com/ahmetcanaydemir/advanced-react-news-ticker">
54 |               <i className="fab fa-github"></i>
55 |             </a>
56 |           </span>
57 |         </div>
58 |       </div>
59 |     </nav>
60 |   );
61 | }
62 | 
63 | export default NavBar;
64 | 


--------------------------------------------------------------------------------
/src/docs/components/hello/index.js:
--------------------------------------------------------------------------------
 1 | import React from "react";
 2 | import NewsTicker from "../../../react-advanced-news-ticker";
 3 | import "./index.css";
 4 | import CodeMirror from "@uiw/react-codemirror";
 5 | 
 6 | function Hello() {
 7 |   return (
 8 |     <div className=" text-center" id="hello" style={{ paddingBottom: 150, paddingTop: 80 }}>
 9 |       <div className="container ">
10 |         <div className="mx-5">
11 |           <h1>
12 |             <span className="text-dark">React Advanced</span> News Ticker{" "}
13 |           </h1>
14 |           <div id="nt-title-container" className="my-5">
15 |             <NewsTicker id="nt-title" maxRows={1} rowHeight={40} duration={3000} pauseOnHover={false}>
16 |               <div>A powerful, flexible and animated vertical news ticker component.</div>
17 |               <div>Provides hight flexibility thanks to numerous callbacks & methods.</div>
18 |               <div>Fully customizable to every kind of vertical scrolling need.</div>
19 |               <div>Light-weight and used only React and JavaScript.</div>
20 |             </NewsTicker>
21 |           </div>
22 |         </div>
23 |         <div className="d-flex align-items-center justify-content-center">
24 |           <a
25 |             className="mr-4 button btn btn-dark border-0"
26 |             href="https://github.com/ahmetcanaydemir/react-advanced-news-ticker/archive/master.zip"
27 |             target="_blank"
28 |             rel="noopener noreferrer">
29 |             Download
30 |           </a>
31 |           <a
32 |             style={{ height: 60 }}
33 |             className="btn btn-light d-flex align-items-center"
34 |             href="https://github.com/ahmetcanaydemir/react-advanced-news-ticker"
35 |             target="_blank"
36 |             rel="noopener noreferrer">
37 |             <i className="fab fa-github" /> View on GitHub
38 |           </a>
39 |         </div>
40 |         <div className="d-flex text-left justify-content-center mt-5">
41 |           <div style={{ width: 320 }}>
42 |             <CodeMirror
43 |               value=" npm i react-advanced-news-ticker"
44 |               options={{
45 |                 theme: "monokai",
46 |                 mode: "jsx",
47 |                 lineNumbers: false,
48 |                 scrollbarStyle: "null",
49 |                 readOnly: true,
50 |               }}
51 |             />
52 |           </div>
53 |         </div>
54 |       </div>
55 |     </div>
56 |   );
57 | }
58 | 
59 | export default Hello;
60 | 


--------------------------------------------------------------------------------
/src/docs/components/example3/index.js:
--------------------------------------------------------------------------------
 1 | import React, { useRef, useState } from "react";
 2 | import NewsTicker, { TickerStates } from "../../../react-advanced-news-ticker/";
 3 | import "./index.css";
 4 | 
 5 | function Example3() {
 6 |   const ref = useRef(null);
 7 | 
 8 |   const [speedAdd, setSpeedAdd] = useState(1);
 9 |   const [speed, setSpeed] = useState(1);
10 |   const [duration, setDuration] = useState(0);
11 |   const [shouldStop, setShouldStop] = useState(false);
12 |   const [currentState, setCurrentState] = useState(TickerStates.Stopped);
13 | 
14 |   const [winner, setWinner] = useState("");
15 | 
16 |   const getButtonContent = () => {
17 |     if (shouldStop)
18 |       return (
19 |         <>
20 |           <span className="ml-2">Waiting...</span>
21 |         </>
22 |       );
23 |     else if (winner)
24 |       return (
25 |         <>
26 |           <span className="ml-2">Result: {winner}</span>
27 |         </>
28 |       );
29 |     else if (currentState === TickerStates.Running)
30 |       return (
31 |         <>
32 |           <span className="ml-2">Stop</span>
33 |         </>
34 |       );
35 |     else
36 |       return (
37 |         <>
38 |           <span className="ml-2">Start</span>
39 |         </>
40 |       );
41 |   };
42 | 
43 |   const startSpin = () => {
44 |     if (currentState === TickerStates.Stopped) {
45 |       setSpeed(1);
46 |       setSpeedAdd(1);
47 |       setDuration(0);
48 |       ref.current.startButtonClick();
49 |       setCurrentState(TickerStates.Running);
50 |     } else if (currentState === TickerStates.Running) {
51 |       setShouldStop(true);
52 |     }
53 |   };
54 | 
55 |   return (
56 |     <div id="nt-example3-container">
57 |       <NewsTicker
58 |         id="nt-example3"
59 |         rowHeight={80}
60 |         maxRows={1}
61 |         duration={duration}
62 |         speed={speed}
63 |         ref={ref}
64 |         autoStart={false}
65 |         pauseOnHover={false}
66 |         hasMoved={() => {
67 |           if (speed > 700) {
68 |             ref.current.stopButtonClick();
69 |             setWinner(ref.current.state.items[0]);
70 |             setCurrentState(TickerStates.Stopped);
71 |             setShouldStop(false);
72 |             setTimeout(() => {
73 |               setWinner("");
74 |             }, 4000);
75 |           } else if (shouldStop) {
76 |             setSpeedAdd(speedAdd * 1.4);
77 |             setSpeed(speed + speedAdd);
78 |             setDuration(speed + 25);
79 |           }
80 |         }}>
81 |         <div>PHARETRA</div>
82 |         <div>MAECENAS</div>
83 |         <div>ONEC</div>
84 |         <div>LOREM</div>
85 |         <div>IPSUM</div>
86 |         <div>PRAESENT</div>
87 |         <div>NUNC</div>
88 |       </NewsTicker>
89 |       <span className="button mt-2" id="nt-example3-button" onClick={startSpin}>
90 |         {getButtonContent()}
91 |       </span>
92 |     </div>
93 |   );
94 | }
95 | 
96 | export default Example3;
97 | 


--------------------------------------------------------------------------------
/src/docs/components/example1/block.js:
--------------------------------------------------------------------------------
  1 | import React, { useState } from "react";
  2 | import Example1 from ".";
  3 | import CodeMirror from "@uiw/react-codemirror";
  4 | import Title from "../title";
  5 | 
  6 | function Example1Block() {
  7 |   const [showCss, setShowCss] = useState(false);
  8 | 
  9 |   const code = `
 10 |   <div id="nt-example1-container">
 11 |       <i className="fa fa-arrow-up" 
 12 |          id="nt-example1-prev" 
 13 |          onClick={() => { ref.current.movePrev(); ref.current.resetInterval(); }} />
 14 |       <NewsTicker 
 15 |          ref={ref} 
 16 |          id="nt-example1" 
 17 |          direction={Directions.UP} 
 18 |          rowHeight={80} 
 19 |          maxRows={3} 
 20 |          duration={4000}>
 21 |           <div>Content 1</div>
 22 |           <div>Content 2</div>
 23 |           <div>Content 3</div>
 24 |           <div>Content 4</div>
 25 |       </NewsTicker>
 26 |       <i className="fa fa-arrow-down" 
 27 |          id="nt-example1-next"
 28 |          onClick={() => { ref.current.moveNext(); ref.current.resetInterval(); }} />
 29 |     </div>`;
 30 | 
 31 |   const css = `
 32 |     #nt-example1 {
 33 |       max-width: 620px;
 34 |       margin: auto;
 35 |     }
 36 | 
 37 |     #nt-example1-container {
 38 |       text-align: center;
 39 |     }
 40 | 
 41 |     #nt-example1-container i {
 42 |       font-size: 36px;
 43 |       margin: 8px;
 44 |       cursor: pointer;
 45 |       -webkit-transition: all 0.1s ease-in-out;
 46 |       -moz-transition: all 0.1s ease-in-out;
 47 |       -ms-transition: all 0.1s ease-in-out;
 48 |       -o-transition: all 0.1s ease-in-out;
 49 |       transition: all 0.1s ease-in-out;
 50 |     }
 51 | 
 52 |     #nt-example1-container i:hover {
 53 |       color: #333;
 54 |     }
 55 | 
 56 |     #nt-example1 li {
 57 |       color: #4e4e4e;
 58 |       background: #f2f2f2;
 59 |       overflow: hidden;
 60 |       height: 80px;
 61 |       padding: 10px;
 62 |       line-height: 30px;
 63 |       list-style: none;
 64 |       font-size: 24px;
 65 |       text-align: left;
 66 |       border-bottom: 1px dotted #2c8162;
 67 |     }
 68 | 
 69 |     #nt-example1 li:hover {
 70 |       background: #fff;
 71 |     }
 72 |     `;
 73 |   return (
 74 |     <>
 75 |       <Title title="Examples" id="examples" />
 76 |       <div className="colored-block text-light pb-5">
 77 |         <div className="container">
 78 |           <h2 className="text-center  py-5">Multilines Simple Example</h2>
 79 |           <div className="row d-flex justify-content-center align-items-center">
 80 |             <div className="col-lg-6">
 81 |               <Example1 />
 82 |             </div>
 83 |             <div className="col-lg-6 ">
 84 |               <div className="d-flex justify-content-end">
 85 |                 <div className="btn btn-light align-self-right mb-2" onClick={() => setShowCss(!showCss)}>
 86 |                   Show {showCss ? "JSX" : "CSS"}
 87 |                 </div>
 88 |               </div>
 89 |               <CodeMirror
 90 |                 value={showCss ? css : code}
 91 |                 height={450}
 92 |                 options={{
 93 |                   theme: "monokai",
 94 |                   mode: "jsx",
 95 |                   lineNumbers: false,
 96 |                   readOnly: true,
 97 |                 }}
 98 |               />
 99 |             </div>
100 |           </div>
101 |         </div>
102 |       </div>
103 |     </>
104 |   );
105 | }
106 | 
107 | export default Example1Block;
108 | 


--------------------------------------------------------------------------------
/src/docs/components/example3/block.js:
--------------------------------------------------------------------------------
  1 | import React, { useState } from "react";
  2 | import CodeMirror from "@uiw/react-codemirror";
  3 | 
  4 | import Example3 from ".";
  5 | 
  6 | function Example3Block() {
  7 |   const [showCss, setShowCss] = useState(false);
  8 | 
  9 |   const code = `
 10 |   const ref = useRef(null);
 11 | 
 12 |   const [speedAdd, setSpeedAdd] = useState(1);
 13 |   const [speed, setSpeed] = useState(1);
 14 |   const [duration, setDuration] = useState(0);
 15 |   const [shouldStop, setShouldStop] = useState(false);
 16 |   const [currentState, setCurrentState] = useState(TickerStates.Stopped);
 17 | 
 18 |   const [winner, setWinner] = useState("");
 19 | 
 20 |   const getButtonContent = () => {
 21 |     if (shouldStop)
 22 |       return (
 23 |         <>
 24 |           <span className="ml-2">Waiting...</span>
 25 |         </>
 26 |       );
 27 |     else if (winner)
 28 |       return (
 29 |         <>
 30 |           <span className="ml-2">Result: {winner}</span>
 31 |         </>
 32 |       );
 33 |     else if (currentState === TickerStates.Running)
 34 |       return (
 35 |         <>
 36 |           <span className="ml-2">Stop</span>
 37 |         </>
 38 |       );
 39 |     else
 40 |       return (
 41 |         <>
 42 |           <span className="ml-2">Start</span>
 43 |         </>
 44 |       );
 45 |   };
 46 | 
 47 |   const startSpin = () => {
 48 |     if (currentState === TickerStates.Stopped) {
 49 |       setSpeed(1);
 50 |       setSpeedAdd(1);
 51 |       setDuration(0);
 52 |       ref.current.startButtonClick();
 53 |       setCurrentState(TickerStates.Running);
 54 |     } else if (currentState === TickerStates.Running) {
 55 |       setShouldStop(true);
 56 |     }
 57 |   };
 58 | 
 59 |   return (
 60 |     <div id="nt-example3-container">
 61 |       <NewsTicker
 62 |         id="nt-example3"
 63 |         rowHeight={80}
 64 |         maxRows={1}
 65 |         duration={duration}
 66 |         speed={speed}
 67 |         ref={ref}
 68 |         autoStart={false}
 69 |         pauseOnHover={false}
 70 |         hasMoved={() => {
 71 |           if (speed > 700) {
 72 |             ref.current.stopButtonClick();
 73 |             setWinner(ref.current.state.items[0]);
 74 |             setCurrentState(TickerStates.Stopped);
 75 |             setShouldStop(false);
 76 |             setTimeout(() => {
 77 |               setWinner("");
 78 |             }, 4000);
 79 |           } else if (shouldStop) {
 80 |             setSpeedAdd(speedAdd * 1.4);
 81 |             setSpeed(speed + speedAdd);
 82 |             setDuration(speed + 25);
 83 |           }
 84 |         }}>
 85 |         <div>PHARETRA</div>
 86 |         <div>MAECENAS</div>
 87 |         <div>ONEC</div>
 88 |         <div>LOREM</div>
 89 |         <div>IPSUM</div>
 90 |         <div>PRAESENT</div>
 91 |         <div>NUNC</div>
 92 |       </NewsTicker>
 93 |       <span className="button mt-2" id="nt-example3-button" onClick={startSpin}>
 94 |         {getButtonContent()}
 95 |       </span>
 96 |     </div>
 97 |   )`;
 98 | 
 99 |   const css = `
100 |   #nt-example3 {
101 |     margin: 80px auto 0;
102 |   }
103 |   
104 |   #nt-example3-container {
105 |     text-align: center;
106 |   }
107 |   
108 |   #nt-example3-container i {
109 |     font-size: 36px;
110 |     margin: 8px;
111 |     cursor: pointer;
112 |     -webkit-transition: all 0.1s ease-in-out;
113 |     -moz-transition: all 0.1s ease-in-out;
114 |     -ms-transition: all 0.1s ease-in-out;
115 |     -o-transition: all 0.1s ease-in-out;
116 |     transition: all 0.1s ease-in-out;
117 |   }
118 |   
119 |   #nt-example3-container i:hover {
120 |     color: #333;
121 |   }
122 |   
123 |   #nt-example3 li {
124 |     color: #4e4e4e;
125 |     background: #f2f2f2;
126 |     overflow: hidden;
127 |     height: 80px;
128 |     padding: 10px;
129 |     line-height: 60px;
130 |     font-size: 40px;
131 |     text-transform: uppercase;
132 |     list-style: none;
133 |   }
134 |   
135 |   #nt-example3 li:hover {
136 |     background: #fff;
137 |   }
138 |     `;
139 |   return (
140 |     <div className="colored-block text-light pb-5">
141 |       <div className="container">
142 |         <h2 className="text-center  py-5">Bonus: "Roulette" Example, Using Callbacks & Methods</h2>
143 |         <div className="row d-flex justify-content-center align-items-center">
144 |           <div className="col-lg-4">
145 |             <Example3 />
146 |           </div>
147 |           <div className="col-lg-8">
148 |             <div className="d-flex justify-content-end">
149 |               <div className="btn btn-light align-self-right mb-2" onClick={() => setShowCss(!showCss)}>
150 |                 Show {showCss ? "JSX" : "CSS"}
151 |               </div>
152 |             </div>
153 |             <CodeMirror
154 |               value={showCss ? css : code}
155 |               height={450}
156 |               options={{
157 |                 theme: "monokai",
158 |                 mode: "jsx",
159 |                 lineNumbers: false,
160 |                 readOnly: true,
161 |               }}
162 |             />
163 |           </div>
164 |         </div>
165 |       </div>
166 |     </div>
167 |   );
168 | }
169 | 
170 | export default Example3Block;
171 | 


--------------------------------------------------------------------------------
/src/docs/components/methods/index.js:
--------------------------------------------------------------------------------
  1 | import React from "react";
  2 | import CodeMirror from "@uiw/react-codemirror";
  3 | import Title from "../title";
  4 | 
  5 | function Methods() {
  6 |   return (
  7 |     <>
  8 |       <Title title="Methods" id="methods" />
  9 |       <div className="colored-block text-light pb-5">
 10 |         <div className="container pt-5" style={{ maxWidth: 900 }}>
 11 |           <div className="mb-2">After creating NewsTicker component with ref, methods are called with</div>
 12 |           <CodeMirror
 13 |             value="ref.current.methodName()"
 14 |             options={{
 15 |               theme: "monokai",
 16 |               mode: "jsx",
 17 |               lineNumbers: false,
 18 |               scrollbarStyle: "null",
 19 |               readOnly: true,
 20 |             }}
 21 |           />
 22 | 
 23 |           <div className="mt-4 mb-2">Example</div>
 24 |           <CodeMirror
 25 |             value={`ref.current.stop()
 26 | ref.current.start()
 27 | ref.current.move()
 28 | ref.current.getState()
 29 | ref.current.pause()`}
 30 |             options={{
 31 |               theme: "monokai",
 32 |               mode: "jsx",
 33 |               lineNumbers: false,
 34 |               readOnly: true,
 35 |               scrollbarStyle: "null",
 36 |             }}
 37 |           />
 38 |         </div>
 39 |       </div>
 40 |       <div className="text-dark pb-5">
 41 |         <div className="container py-5" style={{ fontSize: 14, maxWidth: 900 }}>
 42 |           <h2 className="text-center">Method List</h2>
 43 |           <table className="table table-striped table-responsive params-table">
 44 |             <thead>
 45 |               <tr>
 46 |                 <th>Method</th>
 47 |                 <th>Parameter(s)</th>
 48 |                 <th>Action</th>
 49 |               </tr>
 50 |             </thead>
 51 |             <tbody>
 52 |               <tr>
 53 |                 <td>
 54 |                   <code>start</code>
 55 |                 </td>
 56 |                 <td></td>
 57 |                 <td>starts moving newsTicker elements</td>
 58 |               </tr>
 59 |               <tr>
 60 |                 <td>
 61 |                   <code>stop</code>
 62 |                 </td>
 63 |                 <td></td>
 64 |                 <td>stops moving newsTicker elements</td>
 65 |               </tr>
 66 |               <tr>
 67 |                 <td>
 68 |                   <code>getState</code>
 69 |                 </td>
 70 |                 <td></td>
 71 |                 <td>
 72 |                   returns current state: <code>TickerStates.Stopped</code> = stopped, <code>TickerStates.Running</code>{" "}
 73 |                   = started, <code>TickerStates.Paused</code> = paused (and started)
 74 |                 </td>
 75 |               </tr>
 76 |               <tr>
 77 |                 <td>
 78 |                   <code>pause</code>
 79 |                 </td>
 80 |                 <td></td>
 81 |                 <td>
 82 |                   pauses newsTicker elements without stopping them - the newsTicker has to be started to be able to{" "}
 83 |                   pause it (the <code>pause</code> method is called on <code>mouseOver</code> if{" "}
 84 |                   <code>pauseOnHover</code> = true)
 85 |                 </td>
 86 |               </tr>
 87 |               <tr>
 88 |                 <td>
 89 |                   <code>unpause</code>
 90 |                 </td>
 91 |                 <td></td>
 92 |                 <td>
 93 |                   unpauses newsTicker elements - the newsTicker has to be started &amp; paused to be able to unpause it{" "}
 94 |                   (the <code>unpause</code> method is called on <code>onMouseLeave</code> if <code>pauseOnHover</code> =
 95 |                   true)
 96 |                 </td>
 97 |               </tr>
 98 |               <tr>
 99 |                 <td>
100 |                   <code>moveDown</code>
101 |                 </td>
102 |                 <td></td>
103 |                 <td>moves elements down</td>
104 |               </tr>
105 |               <tr>
106 |                 <td>
107 |                   <code>moveUp</code>
108 |                 </td>
109 |                 <td></td>
110 |                 <td>moves elements up</td>
111 |               </tr>
112 |               <tr>
113 |                 <td>
114 |                   <code>moveNext</code>
115 |                 </td>
116 |                 <td></td>
117 |                 <td>
118 |                   moves up or down according to the current <code>direction</code> option
119 |                 </td>
120 |               </tr>
121 |               <tr>
122 |                 <td>
123 |                   <code>movePrev</code>
124 |                 </td>
125 |                 <td></td>
126 |                 <td>
127 |                   moves up or down according to the current <code>direction</code> option
128 |                 </td>
129 |               </tr>
130 |               <tr>
131 |                 <td>
132 |                   <code>move</code>
133 |                 </td>
134 |                 <td></td>
135 |                 <td>
136 |                   equivalent to <code>moveNext</code>, but will not move if <code>paused</code>
137 |                 </td>
138 |               </tr>
139 |             </tbody>
140 |           </table>
141 |         </div>
142 |       </div>
143 |     </>
144 |   );
145 | }
146 | 
147 | export default Methods;
148 | 


--------------------------------------------------------------------------------
/src/docs/components/example2/block.js:
--------------------------------------------------------------------------------
  1 | import React, { useState } from "react";
  2 | import CodeMirror from "@uiw/react-codemirror";
  3 | import Example2 from ".";
  4 | 
  5 | function Example2Block() {
  6 |   const [showCss, setShowCss] = useState(false);
  7 | 
  8 |   const code = `
  9 |   <div id="nt-example2-container">
 10 |     <NewsTicker
 11 |       ref={ref}
 12 |       id="nt-example2"
 13 |       direction={Directions.UP}
 14 |       rowHeight={60}
 15 |       maxRows={1}
 16 |       speed={300}
 17 |       duration={6000}
 18 |       hasMoved={() => {
 19 |         var index = ref.current.state.items[0].key;
 20 |         setCurrentItem(news[index]);
 21 |       }}
 22 |       paused={() => {
 23 |         document.querySelector("#nt-example2 li i").classList.remove("fa-play");
 24 |         document.querySelector("#nt-example2 li i").classList.add("fa-pause");
 25 |       }}
 26 |       unPaused={() => {
 27 |         document.querySelector("#nt-example2 li i").classList.remove("fa-pause");
 28 |         document.querySelector("#nt-example2 li i").classList.add("fa-play");
 29 |       }}>
 30 |       {news.map((item, i) => (
 31 |         <div key={i}>
 32 |           <i className="fa fa-fw state fa-play" />
 33 |           <span className="hour">{item.hour}</span> {item.title}
 34 |         </div>
 35 |       ))}
 36 |     </NewsTicker>
 37 |     
 38 |     <div id="nt-example2-infos-container">
 39 |       <div id="nt-example2-infos-triangle" />
 40 |       <div
 41 |         id="nt-example2-infos"
 42 |         className="row"
 43 |         onMouseEnter={() => ref.current.pause()}
 44 |         onMouseLeave={() => ref.current.unPause()}>
 45 |         <div className="col-4 centered">
 46 |           <div className="infos-hour">{currentItem.hour}</div>
 47 |           <i className="fa fa-arrow-left"
 48 |             id="nt-example2-prev"
 49 |             onClick={() => { ref.current.movePrev(); ref.current.resetInterval(); }} />
 50 |             
 51 |           <i className="fa fa-arrow-right" 
 52 |             id="nt-example2-next" 
 53 |             onClick={() => { ref.current.moveNext(); ref.current.resetInterval(); }} />
 54 |         </div>
 55 |         <div className="col-8">
 56 |           <div className="infos-text">{currentItem.info}</div>
 57 |         </div>
 58 |       </div>
 59 |     </div>
 60 | </div>`;
 61 | 
 62 |   const css = `
 63 |   #nt-example2 {
 64 |     max-width: 620px;
 65 |     margin: auto;
 66 |   }
 67 |   
 68 |   #nt-example2-container {
 69 |     text-align: center;
 70 |     margin-top: 107px;
 71 |     margin-bottom: 40px;
 72 |     height: 300px;
 73 |   }
 74 |   
 75 |   #nt-example2-container i {
 76 |     font-size: 24px;
 77 |     margin: 8px;
 78 |     cursor: pointer;
 79 |     -webkit-transition: all 0.1s ease-in-out;
 80 |     -moz-transition: all 0.1s ease-in-out;
 81 |     -ms-transition: all 0.1s ease-in-out;
 82 |     -o-transition: all 0.1s ease-in-out;
 83 |     transition: all 0.1s ease-in-out;
 84 |   }
 85 |   
 86 |   #nt-example2-container i:hover {
 87 |     color: #333;
 88 |   }
 89 |   
 90 |   #nt-example2 li {
 91 |     color: #f2f2f2;
 92 |     background: #319795;
 93 |     white-space: nowrap;
 94 |     overflow: hidden;
 95 |     text-overflow: ellipsis;
 96 |     height: 60px;
 97 |     padding: 10px 16px 10px 16px;
 98 |     line-height: 40px;
 99 |     list-style: none;
100 |     font-size: 24px;
101 |     text-align: left;
102 |   }
103 |   
104 |   #nt-example2 li div {
105 |     white-space: nowrap;
106 |     overflow: hidden;
107 |     text-overflow: ellipsis;
108 |   }
109 |   
110 |   #nt-example2 li div .state {
111 |     font-size: inherit;
112 |     margin: 0;
113 |   }
114 |   
115 |   #nt-example2 span.hour {
116 |     font-weight: 700;
117 |   }
118 |   
119 |   #nt-example2-infos-triangle {
120 |     width: 0px;
121 |     height: 0px;
122 |     border-style: solid;
123 |     border-width: 0 15px 16px 15px;
124 |     border-color: transparent transparent #319795 transparent;
125 |     margin: 6px auto 0;
126 |   }
127 |   
128 |   #nt-example2-infos {
129 |     max-width: 620px;
130 |     margin: auto;
131 |     padding: 12px;
132 |     color: #f2f2f2;
133 |     background: #319795;
134 |   }
135 |   
136 |   #nt-example2-infos .infos-hour {
137 |     font-size: 32px;
138 |     font-weight: 700;
139 |     margin-top: 20px;
140 |   }
141 |   
142 |   #nt-example2-infos h4 {
143 |     color: #f2f2f2;
144 |     font-weight: 500;
145 |   }
146 |   
147 |   #nt-example2-infos .infos-text {
148 |     text-align: left;
149 |   }  
150 |     `;
151 |   return (
152 |     <div className="text-dark pb-5">
153 |       <div className="container">
154 |         <h2 className="text-center  py-5">One Line Ticker With Callbacks & Methods Example</h2>
155 |         <div className="row d-flex ">
156 |           <div className="col-lg-6 ">
157 |             <div className="d-flex justify-content-end">
158 |               <div className="btn btn-light align-self-right mb-2" onClick={() => setShowCss(!showCss)}>
159 |                 Show {showCss ? "JSX" : "CSS"}
160 |               </div>
161 |             </div>
162 |             <CodeMirror
163 |               value={showCss ? css : code}
164 |               height={450}
165 |               options={{
166 |                 theme: "monokai",
167 |                 mode: "jsx",
168 |                 lineNumbers: false,
169 |                 readOnly: true,
170 |               }}
171 |             />
172 |           </div>
173 |           <div className="col-lg-6">
174 |             <div style={{ height: 540 }}>
175 |               <Example2 />
176 |             </div>
177 |           </div>
178 |         </div>
179 |       </div>
180 |     </div>
181 |   );
182 | }
183 | 
184 | export default Example2Block;
185 | 


--------------------------------------------------------------------------------
/src/docs/components/usage/index.js:
--------------------------------------------------------------------------------
  1 | import React from "react";
  2 | import CodeMirror from "@uiw/react-codemirror";
  3 | import Title from "../title";
  4 | 
  5 | function Usage() {
  6 |   const codeImport = ` import NewsTicker from "react-advanced-news-ticker";
  7 |   // When you need, you can import enums like this:
  8 |   // import NewsTicker, { Directions, TickerStates } from "react-advanced-news-ticker";
  9 |   `;
 10 | 
 11 |   const codeBasic = `<NewsTicker>
 12 |     <div>Etiam imperdiet volutpat libero eu tristique.</div>
 13 |     <div>Curabitur porttitor ante eget hendrerit adipiscing.</div>
 14 |     <div>Praesent ornare nisl lorem, ut condimentum lectus gravida ut.</div>
 15 |     <div>Nunc ultrices tortor eu massa placerat posuere.</div>
 16 |  </NewsTicker>`;
 17 | 
 18 |   const codeCustomParameters = `<NewsTicker
 19 |     rowHeight = {48}
 20 |     maxRows = {2}
 21 |     speed = {600}
 22 |     direction = {Directions.UP}
 23 |     duration = {4000}
 24 |     autoStart = {true}
 25 |     pauseOnHover = {false}
 26 |     id = "myId"
 27 |     className = "myClassName1 myClassName2"
 28 |     style = {{marginTop: 34}}>
 29 |     <div>Etiam imperdiet volutpat libero eu tristique.</div>
 30 |     <div>Curabitur porttitor ante eget hendrerit adipiscing.</div>
 31 |     <div>Praesent ornare nisl lorem, ut condimentum lectus gravida ut.</div>
 32 |     <div>Nunc ultrices tortor eu massa placerat posuere.</div>
 33 | </NewsTicker>`;
 34 | 
 35 |   const codeWithCallbacks = `const updateInfos = () => {
 36 |   ...
 37 | }
 38 | 
 39 | return <NewsTicker
 40 |     maxRows = {1}
 41 |     duration = {6000}
 42 |     hasMoved = {updateInfos}
 43 |     started = {()=>{ 
 44 |       console.log('react advanced news ticker just started!');
 45 |     }}
 46 |     paused = {()=>{ 
 47 |       console.log('react advanced news ticker has been paused.');
 48 |     }}>
 49 |     <div>Etiam imperdiet volutpat libero eu tristique.</div>
 50 |     <div>Curabitur porttitor ante eget hendrerit adipiscing.</div>
 51 |     <div>Praesent ornare nisl lorem, ut condimentum lectus gravida ut.</div>
 52 |     <div>Nunc ultrices tortor eu massa placerat posuere.</div>
 53 | </NewsTicker>`;
 54 | 
 55 |   const codeWithMethods = `const newsTickerRef = useRef(null);
 56 | return <>
 57 |   <NewsTicker
 58 |       ref = {newsTickerRef}
 59 |       autoStart = {false}
 60 |       speed = {400}>
 61 |       <div>Etiam imperdiet volutpat libero eu tristique.</div>
 62 |       <div>Curabitur porttitor ante eget hendrerit adipiscing.</div>
 63 |       <div>Praesent ornare nisl lorem, ut condimentum lectus gravida ut.</div>
 64 |       <div>Nunc ultrices tortor eu massa placerat posuere.</div>
 65 |   </NewsTicker>
 66 |   
 67 |   <button
 68 |     onClick={() => { newsTickerRef.current.start() }}>
 69 |     Start
 70 |   </button>
 71 |   
 72 |   <div 
 73 |     onMouseEnter={() => newsTickerRef.current.pause()}
 74 |     onMouseLeave={() => newsTickerRef.current.unPause()}>
 75 |      Pause
 76 |   </div>
 77 | </>`;
 78 |   return (
 79 |     <>
 80 |       <Title title="Usage" id="usage" />
 81 | 
 82 |       <div className="text-dark pb-5">
 83 |         <div className="container py-5 px-4" style={{ maxWidth: 900 }}>
 84 |           <div className="row">
 85 |             <div className="mb-2">Import react advanced news ticker:</div>
 86 |             <CodeMirror
 87 |               value={codeImport}
 88 |               options={{
 89 |                 theme: "monokai",
 90 |                 mode: "jsx",
 91 |                 lineNumbers: false,
 92 |                 scrollbarStyle: "null",
 93 |                 readOnly: true,
 94 |               }}
 95 |             />
 96 |           </div>
 97 |           <div className="row mt-5">
 98 |             <div className="mb-2">
 99 |               Basically create NewsTicker element and give your components as children. You can also use your own custom
100 |               componets.
101 |             </div>
102 |             <CodeMirror
103 |               value={codeBasic}
104 |               options={{
105 |                 theme: "monokai",
106 |                 mode: "jsx",
107 |                 lineNumbers: false,
108 |                 scrollbarStyle: "null",
109 |                 readOnly: true,
110 |               }}
111 |             />
112 |           </div>
113 | 
114 |           <div className="row mt-5">
115 |             <div className="mb-2">With custom parameters:</div>
116 |             <CodeMirror
117 |               value={codeCustomParameters}
118 |               options={{
119 |                 theme: "monokai",
120 |                 mode: "jsx",
121 |                 lineNumbers: false,
122 |                 scrollbarStyle: "null",
123 |                 readOnly: true,
124 |               }}
125 |             />
126 |           </div>
127 | 
128 |           <div className="row mt-5">
129 |             <div className="mb-2">With callbacks:</div>
130 |             <CodeMirror
131 |               value={codeWithCallbacks}
132 |               options={{
133 |                 theme: "monokai",
134 |                 mode: "jsx",
135 |                 lineNumbers: false,
136 |                 scrollbarStyle: "null",
137 |                 readOnly: true,
138 |               }}
139 |             />
140 |           </div>
141 | 
142 |           <div className="row mt-5">
143 |             <div className="mb-2">With methods. You need to use ref for using methods.</div>
144 |             <CodeMirror
145 |               value={codeWithMethods}
146 |               options={{
147 |                 theme: "monokai",
148 |                 mode: "jsx",
149 |                 lineNumbers: false,
150 |                 scrollbarStyle: "null",
151 |                 readOnly: true,
152 |               }}
153 |             />
154 |           </div>
155 |         </div>
156 |       </div>
157 |     </>
158 |   );
159 | }
160 | 
161 | export default Usage;
162 | 


--------------------------------------------------------------------------------
/src/docs/components/example2/index.js:
--------------------------------------------------------------------------------
  1 | import React, { useRef, useState } from "react";
  2 | import NewsTicker, { Directions } from "../../../react-advanced-news-ticker";
  3 | import "./index.css";
  4 | 
  5 | function Example2() {
  6 |   const ref = useRef(null);
  7 | 
  8 |   const news = [
  9 |     {
 10 |       hour: "10:02",
 11 |       title: "Praesent ornare nisl lorem, ut condi.",
 12 |       info:
 13 |         "Vestibulum ac interdum quam, tempus aliquet purus. Nunc luctus augue ut pellentesque faucibus. Proin urna nunc, feugiat ac bibendum non, cursus id orci. Integer porttitor diam et odio pharetra, sed congue augue dapibus. Fusce ac tristique tortor. Aliquam adipiscing ligula in dui pretium ultrices.",
 14 |     },
 15 |     {
 16 |       hour: "10:14",
 17 |       title: "Nunc ultrices tortor eu massa placerat posuere.",
 18 |       info:
 19 |         "Proin vulputate mi pharetra tellus semper dapibus. Vestibulum non metus convallis, lobortis velit eu, facilisis mauris. Mauris mattis ante sit amet nulla egestas, ut consectetur tortor tristique. In porttitor non eros nec scelerisque. Sed eu condimentum tellus, et feugiat urna. Duis semper ligula a risus suscipit, ut vestibulum mi tempor.",
 20 |     },
 21 |     {
 22 |       hour: "11:23",
 23 |       title: "Morbi sodales tellus sit amet leo congue bibendum.",
 24 |       info:
 25 |         "Sed facilisis, erat at accumsan tincidunt, metus diam convallis tortor, at facilisis tortor libero sed ante. Sed ut felis sed felis scelerisque bibendum. Ut quis aliquet magna. Phasellus elementum volutpat mattis. Proin in rutrum ante, at imperdiet dolor. Vivamus congue turpis facilisis congue ullamcorper. Etiam sollicitudin quis dolor hendrerit ultricies.",
 26 |     },
 27 |     {
 28 |       hour: "11:45",
 29 |       title: "In pharetra suscipit orci sed viverra. Praesent at.",
 30 |       info:
 31 |         "Raesent aliquam sapien quis pretium vestibulum. Vestibulum varius velit leo, quis facilisis enim mattis id. Proin et tempor ligula, id dapibus neque. Aliquam egestas adipiscing tellus. Morbi enim leo, fringilla eget vulputate tincidunt, fringilla et sapien. Curabitur ultricies auctor lectus, quis ultricies sem tincidunt sit amet. Mauris non tempor ipsum. Sed sed ipsum nulla. Quisque laoreet velit dolor, nec placerat odio ullamcorper eget.",
 32 |     },
 33 |     {
 34 |       hour: "11:55",
 35 |       title: "Maecenas nec ligula sed est suscipit aliquet sed.",
 36 |       info:
 37 |         "Praesent ut eleifend lorem. Duis ut velit quis mauris molestie aliquam vitae id diam. Etiam eget mauris condimentum, lacinia lectus et, aliquet ligula. Nulla rutrum tincidunt tincidunt. Maecenas eu dolor vestibulum, pellentesque erat non, molestie nibh. Morbi ac semper quam. Aliquam erat volutpat.",
 38 |     },
 39 |     {
 40 |       hour: "12:00",
 41 |       title: "Onec bibendum consectetur diam, nec eui.",
 42 |       info:
 43 |         "Duis euismod, mi nec posuere malesuada, nisl leo bibendum ligula, sit amet vestibulum est neque non sapien. Curabitur mi massa, bibendum cursus scelerisque imperdiet, semper eu lacus. Etiam mauris eros, faucibus eu pretium vitae, rutrum vel urna. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Proin laoreet pellentesque felis, sed vulputate justo rhoncus et.",
 44 |     },
 45 |     {
 46 |       hour: "08:12",
 47 |       title: "Etiam imperdiet volutpat libero eu tristique.",
 48 |       info:
 49 |         "Cras sagittis nulla sit amet feugiat pulvinar. Fusce scelerisque aliquet purus, sit amet rutrum augue euismod ut. Aliquam erat volutpat. Integer convallis, ligula non bibendum dictum, ante lectus fringilla nunc, at euismod neque enim sit amet ante. In risus velit, porttitor blandit magna vel, adipiscing semper libero.",
 50 |     },
 51 |     {
 52 |       hour: "08:41",
 53 |       title: "Curabitur porttitor ante eget hendrerit adipi.",
 54 |       info:
 55 |         "Quisque imperdiet, tellus et tempus mattis, risus ipsum molestie leo, in tincidunt nisl nunc at magna. Suspendisse pretium ullamcorper feugiat. Nunc quis egestas odio, eu vestibulum nisl. In hac habitasse platea dictumst. Aliquam vel dapibus lacus. Curabitur pharetra quam purus. Suspendisse sed nulla condimentum nibh blandit consectetur non eget velit.",
 56 |     },
 57 |   ];
 58 |   const [currentItem, setCurrentItem] = useState(news[0]);
 59 | 
 60 |   return (
 61 |     <div id="nt-example2-container">
 62 |       <NewsTicker
 63 |         ref={ref}
 64 |         id="nt-example2"
 65 |         direction={Directions.UP}
 66 |         rowHeight={60}
 67 |         maxRows={1}
 68 |         speed={300}
 69 |         duration={6000}
 70 |         hasMoved={() => {
 71 |           var index = ref.current.state.items[0].key;
 72 |           setCurrentItem(news[index]);
 73 |         }}
 74 |         paused={() => {
 75 |           document.querySelector("#nt-example2 li i").classList.remove("fa-play");
 76 |           document.querySelector("#nt-example2 li i").classList.add("fa-pause");
 77 |         }}
 78 |         unPaused={() => {
 79 |           document.querySelector("#nt-example2 li i").classList.remove("fa-pause");
 80 |           document.querySelector("#nt-example2 li i").classList.add("fa-play");
 81 |         }}>
 82 |         {news.map((item, i) => (
 83 |           <div key={i} style={{ marginTop: 0 }}>
 84 |             <i className="fa fa-fw state fa-play" />
 85 |             <span className="hour">{item.hour}</span> {item.title}
 86 |           </div>
 87 |         ))}
 88 |       </NewsTicker>
 89 |       <div id="nt-example2-infos-container" style={{ display: "block" }}>
 90 |         <div id="nt-example2-infos-triangle" />
 91 |         <div
 92 |           id="nt-example2-infos"
 93 |           className="row"
 94 |           onMouseEnter={() => ref.current.pause()}
 95 |           onMouseLeave={() => ref.current.unPause()}>
 96 |           <div className="col-4 centered">
 97 |             <div className="infos-hour">{currentItem.hour}</div>
 98 |             <i
 99 |               className="fa fa-arrow-left"
100 |               id="nt-example2-prev"
101 |               onClick={() => {
102 |                 ref.current.movePrev();
103 |                 ref.current.resetInterval();
104 |               }}
105 |             />
106 |             <i
107 |               className="fa fa-arrow-right"
108 |               id="nt-example2-next"
109 |               onClick={() => {
110 |                 ref.current.moveNext();
111 |                 ref.current.resetInterval();
112 |               }}
113 |             />
114 |           </div>
115 |           <div className="col-8">
116 |             <div className="infos-text">{currentItem.info}</div>
117 |           </div>
118 |         </div>
119 |       </div>
120 |     </div>
121 |   );
122 | }
123 | 
124 | export default Example2;
125 | 


--------------------------------------------------------------------------------
/src/react-advanced-news-ticker/index.js:
--------------------------------------------------------------------------------
  1 | import React, { Component } from "react";
  2 | 
  3 | import PropTypes from "prop-types";
  4 | export const Directions = Object.freeze({ UP: 1, DOWN: 2 });
  5 | export const TickerStates = Object.freeze({ Stopped: 0, Running: 1, Paused: 2 });
  6 | 
  7 | class NewsTicker extends Component {
  8 |   constructor(props) {
  9 |     super(props);
 10 |     this.state = {
 11 |       speed: this.props.speed,
 12 |       currState: 0,
 13 |       paused: 0,
 14 |       moving: 0,
 15 |       moveInterval: null,
 16 |       items: (Array.isArray(this.props.children) && this.props.children) || [this.props.children],
 17 |     };
 18 | 
 19 |     this.element = React.createRef();
 20 |   }
 21 |   componentDidMount() {
 22 |     this.init();
 23 |   }
 24 |   componentWillUnmount() {
 25 |     if (this.state.moveInterval) clearInterval(this.state.moveInterval);
 26 |   }
 27 | 
 28 |   init() {
 29 |     this.element.current.style.height = `${this.props.rowHeight * this.props.maxRows}px`;
 30 |     this.element.current.style.overflow = `hidden`;
 31 |     this.checkSpeed();
 32 | 
 33 |     if (this.props.autoStart) this.start();
 34 |   }
 35 | 
 36 |   start() {
 37 |     if (this.state.currState) return;
 38 | 
 39 |     this.setState(
 40 |       (_, props) => ({
 41 |         currState: 1,
 42 |         items: (Array.isArray(this.props.children) && this.props.children) || [this.props.children],
 43 |       }),
 44 |       () => {
 45 |         this.resetInterval();
 46 |         this.props.started();
 47 |       }
 48 |     );
 49 |   }
 50 |   stop() {
 51 |     if (!this.state.currState) return;
 52 | 
 53 |     clearInterval(this.state.moveInterval);
 54 |     this.setState({ currState: 0 }, () => this.props.stopped());
 55 |   }
 56 | 
 57 |   resetInterval() {
 58 |     if (!this.state.currState) return;
 59 |     clearInterval(this.state.moveInterval);
 60 |     this.setState({
 61 |       moveInterval: setInterval(() => this.move(), this.props.duration),
 62 |     });
 63 |   }
 64 |   move() {
 65 |     if (!this.state.paused) this.moveNext();
 66 |   }
 67 |   moveNext() {
 68 |     if (this.props.direction === Directions.DOWN) this.moveDown();
 69 |     else this.moveUp();
 70 |   }
 71 |   movePrev() {
 72 |     if (this.props.direction === Directions.DOWN) this.moveUp();
 73 |     else this.moveDown();
 74 |   }
 75 |   pause() {
 76 |     if (!this.state.paused) this.setState({ paused: 1 }, () => this.props.paused());
 77 |   }
 78 |   unPause() {
 79 |     if (this.state.paused) {
 80 |       this.setState({ paused: 0 }, () => this.props.unPaused());
 81 |     }
 82 |   }
 83 | 
 84 |   async _handleDownAnimation(newList) {
 85 |     const firsLiEl = this.element.current.children[0];
 86 |     const speed = this.props.speed;
 87 | 
 88 |     await this.setState({ items: newList });
 89 |     // Hide first li element at up
 90 |     firsLiEl.style.cssText = `margin: -${this.props.rowHeight}px 0 0 0`;
 91 | 
 92 |     // First element will go down in speed ms
 93 |     setTimeout(() => {
 94 |       firsLiEl.style.cssText = `margin: 0;transition: margin ${speed}ms;`;
 95 |     }, 0);
 96 | 
 97 |     // Wait for speed ms and add last element to beginning of the list.
 98 |     await new Promise((resolve) =>
 99 |       setTimeout(async () => {
100 |         newList.pop();
101 |         await this.setState({ items: newList });
102 | 
103 |         resolve();
104 |       }, speed)
105 |     );
106 |   }
107 | 
108 |   async moveDown() {
109 |     if (this.state.moving) return;
110 | 
111 |     await this.setState({ moving: 1 });
112 |     this.props.movingDown();
113 | 
114 |     const itemsCopy = [...this.state.items];
115 |     itemsCopy.unshift(itemsCopy[itemsCopy.length - 1]);
116 | 
117 |     await this._handleDownAnimation(itemsCopy);
118 | 
119 |     await this.setState({ moving: 0 });
120 |     this.props.hasMoved();
121 |   }
122 | 
123 |   async _handleUpAnimation(newList) {
124 |     const firsLiEl = this.element.current.children[0];
125 |     await this.setState({ items: newList });
126 | 
127 |     // First element will go up rowHeight px in speed ms
128 |     setTimeout(
129 |       () =>
130 |         (firsLiEl.style.cssText = `margin: -${this.props.rowHeight}px 0 0 0; transition: all ${this.props.speed}ms;`),
131 |       0
132 |     );
133 | 
134 |     // Wait for speed ms and send first element to end of the list.
135 |     // After that get first list element back to margin 0.
136 |     await new Promise((resolve) =>
137 |       setTimeout(async () => {
138 |         newList.shift();
139 |         await this.setState({ items: newList });
140 |         firsLiEl.style.cssText = "margin: 0";
141 |         resolve();
142 |       }, this.props.speed)
143 |     );
144 |   }
145 | 
146 |   async moveUp() {
147 |     if (this.state.moving) return;
148 | 
149 |     await this.setState({ moving: 1 });
150 |     this.props.movingUp();
151 | 
152 |     const itemsCopy = [...this.state.items];
153 |     itemsCopy.push(itemsCopy[0]);
154 | 
155 |     await this._handleUpAnimation(itemsCopy);
156 | 
157 |     await this.setState({ moving: 0 });
158 |     this.props.hasMoved();
159 |   }
160 | 
161 |   getState() {
162 |     if (this.state.paused) return TickerStates.Paused;
163 |     else return this.state.currState ? TickerStates.Running : TickerStates.Stopped;
164 |   }
165 | 
166 |   checkSpeed() {
167 |     if (this.props.duration < this.state.speed + 25) this.setState((_, props) => ({ speed: props.duration - 25 }));
168 |   }
169 | 
170 |   prevButtonClick() {
171 |     this.movePrev();
172 |     this.resetInterval();
173 |   }
174 | 
175 |   nextButtonClick() {
176 |     this.moveNext();
177 |     this.resetInterval();
178 |   }
179 | 
180 |   startButtonClick() {
181 |     this.start();
182 |   }
183 | 
184 |   stopButtonClick() {
185 |     this.stop();
186 |   }
187 | 
188 |   render() {
189 |     return (
190 |       <ul
191 |         className={this.props.className}
192 |         id={this.props.id}
193 |         style={this.props.style}
194 |         ref={this.element}
195 |         onMouseEnter={() => {
196 |           this.props.pauseOnHover && this.state.currState && this.pause();
197 |         }}
198 |         onMouseLeave={() => {
199 |           this.props.pauseOnHover && this.state.currState && this.unPause();
200 |         }}>
201 |         {this.state.items && this.state.items.map((item, index) => <li key={index}>{item}</li>)}
202 |       </ul>
203 |     );
204 |   }
205 | }
206 | 
207 | NewsTicker.propTypes = {
208 |   rowHeight: PropTypes.number,
209 |   maxRows: PropTypes.number,
210 |   children: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.node), PropTypes.node]).isRequired,
211 |   speed: PropTypes.number,
212 |   duration: PropTypes.number,
213 |   direction: PropTypes.oneOf([Directions.UP, Directions.DOWN]),
214 |   autoStart: PropTypes.bool,
215 |   pauseOnHover: PropTypes.bool,
216 |   className: PropTypes.string,
217 |   id: PropTypes.string,
218 |   style: PropTypes.object,
219 |   hasMoved: PropTypes.func,
220 |   movingUp: PropTypes.func,
221 |   movingDown: PropTypes.func,
222 |   started: PropTypes.func,
223 |   stopped: PropTypes.func,
224 |   paused: PropTypes.func,
225 |   unPaused: PropTypes.func,
226 | };
227 | NewsTicker.defaultProps = {
228 |   rowHeight: 22,
229 |   children: [],
230 |   maxRows: 3,
231 |   speed: 400,
232 |   duration: 2500,
233 |   direction: Directions.UP,
234 |   autoStart: true,
235 |   pauseOnHover: true,
236 |   className: "",
237 |   style: {},
238 |   id: "",
239 |   hasMoved: function () {},
240 |   movingUp: function () {},
241 |   movingDown: function () {},
242 |   started: function () {},
243 |   stopped: function () {},
244 |   paused: function () {},
245 |   unPaused: function () {},
246 | };
247 | export default NewsTicker;
248 | 


--------------------------------------------------------------------------------
/src/docs/components/props/index.js:
--------------------------------------------------------------------------------
  1 | import React from "react";
  2 | import Title from "../title";
  3 | 
  4 | function Props() {
  5 |   return (
  6 |     <>
  7 |       <Title title="Props" id="props" />
  8 | 
  9 |       <div className="text-dark pb-5">
 10 |         <div className="container py-5" style={{ fontSize: 14, maxWidth: 900 }}>
 11 |           <table className="table table-striped table-responsive params-table">
 12 |             <thead>
 13 |               <tr>
 14 |                 <th>Parameter</th>
 15 |                 <th>Usage</th>
 16 |                 <th>Type/Values</th>
 17 |                 <th>Default</th>
 18 |               </tr>
 19 |             </thead>
 20 |             <tbody>
 21 |               <tr>
 22 |                 <td>
 23 |                   <code>rowHeight</code>
 24 |                 </td>
 25 |                 <td>defines the height (in px) of one row</td>
 26 |                 <td>
 27 |                   <code>int</code>
 28 |                 </td>
 29 |                 <td>
 30 |                   <em>22</em>
 31 |                 </td>
 32 |               </tr>
 33 |               <tr>
 34 |                 <td>
 35 |                   <code>maxRows</code>
 36 |                 </td>
 37 |                 <td>defines the number of rows displayed at the same time</td>
 38 |                 <td>
 39 |                   <code>int</code>
 40 |                 </td>
 41 |                 <td>
 42 |                   <em>3</em>
 43 |                 </td>
 44 |               </tr>
 45 |               <tr>
 46 |                 <td>
 47 |                   <code>speed</code>
 48 |                 </td>
 49 |                 <td>defines the animation speed (in ms)of the rows moving up or down</td>
 50 |                 <td>
 51 |                   <code>int</code> <em>(in ms)</em>
 52 |                 </td>
 53 |                 <td>
 54 |                   <em>400</em>
 55 |                 </td>
 56 |               </tr>
 57 |               <tr>
 58 |                 <td>
 59 |                   <code>duration</code>
 60 |                 </td>
 61 |                 <td>defines the times (in ms) before the rows automatically move</td>
 62 |                 <td>
 63 |                   <code>int</code> <em>(in ms)</em>
 64 |                 </td>
 65 |                 <td>
 66 |                   <em>2500</em>
 67 |                 </td>
 68 |               </tr>
 69 |               <tr>
 70 |                 <td>
 71 |                   <code>direction</code>
 72 |                 </td>
 73 |                 <td>defines the direction of the rows movement</td>
 74 |                 <td>
 75 |                   <code>Directions.UP</code> <em>or</em> <code>Directions.DOWN</code>
 76 |                 </td>
 77 |                 <td>
 78 |                   <em>Directions.UP</em>
 79 |                 </td>
 80 |               </tr>
 81 |               <tr>
 82 |                 <td>
 83 |                   <code>autoStart</code>
 84 |                 </td>
 85 |                 <td>enable/disable auto start on load</td>
 86 |                 <td>
 87 |                   <code>bool</code>
 88 |                 </td>
 89 |                 <td>
 90 |                   <em>true</em>
 91 |                 </td>
 92 |               </tr>
 93 |               <tr>
 94 |                 <td>
 95 |                   <code>pauseOnHover</code>
 96 |                 </td>
 97 |                 <td>enable/disable pause when mouse hovers the newsTicker element</td>
 98 |                 <td>
 99 |                   <code>bool</code>
100 |                 </td>
101 |                 <td>
102 |                   <em>true</em>
103 |                 </td>
104 |               </tr>
105 |               <tr>
106 |                 <td>
107 |                   <code>className</code>
108 |                 </td>
109 |                 <td>for define className of newsTicker's ul element </td>
110 |                 <td>
111 |                   <code>string</code>
112 |                 </td>
113 |                 <td>
114 |                   <em>''</em>
115 |                 </td>
116 |               </tr>
117 |               <tr>
118 |                 <td>
119 |                   <code>id</code>
120 |                 </td>
121 |                 <td>for define id of newsTicker's ul element </td>
122 |                 <td>
123 |                   <code>string</code>
124 |                 </td>
125 |                 <td>
126 |                   <em>''</em>
127 |                 </td>
128 |               </tr>
129 |               <tr>
130 |                 <td>
131 |                   <code>style</code>
132 |                 </td>
133 |                 <td>for styling newsTicker's ul element </td>
134 |                 <td>
135 |                   <code>object</code>
136 |                 </td>
137 |                 <td>
138 |                   <em>{"{}"}</em>
139 |                 </td>
140 |               </tr>
141 |               <tr>
142 |                 <td>
143 |                   <code>hasMoved</code>
144 |                 </td>
145 |                 <td>
146 |                   <code>callback</code> called at the end of every movement animation
147 |                 </td>
148 |                 <td>
149 |                   <code>function</code>
150 |                 </td>
151 |                 <td></td>
152 |               </tr>
153 |               <tr>
154 |                 <td>
155 |                   <code>movingUp</code>
156 |                 </td>
157 |                 <td>
158 |                   <code>callback</code> called before launching <code>moving up</code> action
159 |                 </td>
160 |                 <td>
161 |                   <code>function</code>
162 |                 </td>
163 |                 <td></td>
164 |               </tr>
165 |               <tr>
166 |                 <td>
167 |                   <code>movingDown</code>
168 |                 </td>
169 |                 <td>
170 |                   <code>callback</code> called before launching <code>moving down</code> action
171 |                 </td>
172 |                 <td>
173 |                   <code>function</code>
174 |                 </td>
175 |                 <td></td>
176 |               </tr>
177 |               <tr>
178 |                 <td>
179 |                   <code>started</code>
180 |                 </td>
181 |                 <td>
182 |                   <code>callback</code> called on <code>start</code> action
183 |                 </td>
184 |                 <td>
185 |                   <code>function</code>
186 |                 </td>
187 |                 <td></td>
188 |               </tr>
189 |               <tr>
190 |                 <td>
191 |                   <code>stopped</code>
192 |                 </td>
193 |                 <td>
194 |                   <code>callback</code> called on <code>stop</code> action
195 |                 </td>
196 |                 <td>
197 |                   <code>function</code>
198 |                 </td>
199 |                 <td></td>
200 |               </tr>
201 |               <tr>
202 |                 <td>
203 |                   <code>paused</code>
204 |                 </td>
205 |                 <td>
206 |                   <code>callback</code> called on <code>pause</code> action (triggered on <code>onMouseEnter</code> if
207 |                   <code> pauseOnHover=true</code>)
208 |                 </td>
209 |                 <td>
210 |                   <code>function</code>
211 |                 </td>
212 |                 <td></td>
213 |               </tr>
214 |               <tr>
215 |                 <td>
216 |                   <code>unPaused</code>
217 |                 </td>
218 |                 <td>
219 |                   called on <code>unpause</code> action (triggered on <code>onMouseLeave</code> if{" "}
220 |                   <code>pauseOnHover=true</code>)
221 |                 </td>
222 |                 <td>
223 |                   <code>function</code>
224 |                 </td>
225 |                 <td></td>
226 |               </tr>
227 |             </tbody>
228 |           </table>
229 |         </div>
230 |       </div>
231 |     </>
232 |   );
233 | }
234 | 
235 | export default Props;
236 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | <h1 align="center">React Advanced News Ticker</h1>
  2 | 
  3 | ![alt text](public/gif.gif "React Advanced News Ticker Gif")
  4 | 
  5 | <p>
  6 |   <a href="https://www.npmjs.com/package/react-advanced-news-ticker" target="_blank">
  7 |     <img alt="Version" src="https://img.shields.io/npm/v/react-advanced-news-ticker.svg">
  8 |   </a>
  9 |   <a href="https://ahmetcanaydemir.github.io/react-advanced-news-ticker" target="_blank">
 10 |     <img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" />
 11 |   </a>
 12 |   <a href="https://github.com/ahmetcanaydemir/react-advanced-news-ticker/graphs/commit-activity" target="_blank">
 13 |     <img alt="Maintenance" src="https://img.shields.io/badge/Maintained%3F-yes-green.svg" />
 14 |   </a>
 15 |   <a href="https://github.com/ahmetcanaydemir/react-advanced-news-ticker/blob/master/LICENSE" target="_blank">
 16 |     <img alt="License: GPL--2.0" src="https://img.shields.io/github/license/ahmetcanaydemir/react-advanced-news-ticker" />
 17 |   </a>
 18 |   <a href="https://twitter.com/ahmetcnaydemir" target="_blank">
 19 |     <img alt="Twitter: ahmetcnaydemir" src="https://img.shields.io/twitter/follow/ahmetcnaydemir.svg?style=social" />
 20 |   </a>
 21 | </p>
 22 | 
 23 | > A powerful, flexible and animated vertical news ticker plugin for React. React Advanced News Ticker provides multiple callbacks and methods to allow a maximum flexibility and an easy implementation into any project.
 24 | 
 25 | ### 🏠 [Demo](https://ahmetcanaydemir.github.io/react-advanced-news-ticker)
 26 | 
 27 | ## ⚡️ Quickstart
 28 | 
 29 | ```JSX
 30 | <NewsTicker>
 31 |   <div>Etiam imperdiet volutpat libero eu tristique.</div>
 32 |   <div>Curabitur porttitor ante eget hendrerit adipiscing.</div>
 33 |   <div>Praesent ornare nisl lorem, ut condimentum lectus gravida ut.</div>
 34 |   <div>Nunc ultrices tortor eu massa placerat posuere.</div>
 35 | </NewsTicker>
 36 | ```
 37 | 
 38 | ## ⚙️ Installation
 39 | 
 40 | ```sh
 41 | npm i react-advanced-news-ticker
 42 | ```
 43 | 
 44 | ## 👀 Examples
 45 | 
 46 | #### 📖 With Custom Props
 47 | 
 48 | ```JSX
 49 | <NewsTicker
 50 |     rowHeight = {48}
 51 |     maxRows = {2}
 52 |     speed = {600}
 53 |     direction = {Directions.UP}
 54 |     duration = {4000}
 55 |     autoStart = {true}
 56 |     pauseOnHover = {false}
 57 |     id = "myId"
 58 |     className = "myClassName1 myClassName2"
 59 |     style = {{marginTop: 34}}>
 60 |     <div>Etiam imperdiet volutpat libero eu tristique.</div>
 61 |     <div>Curabitur porttitor ante eget hendrerit adipiscing.</div>
 62 |     <div>Praesent ornare nisl lorem, ut condimentum lectus gravida ut.</div>
 63 |     <div>Nunc ultrices tortor eu massa placerat posuere.</div>
 64 | </NewsTicker>
 65 | ```
 66 | 
 67 | #### 📖 With Callbacks
 68 | 
 69 | ```JSX
 70 | const updateInfos = () => {
 71 |   ...
 72 | }
 73 | 
 74 | return <NewsTicker
 75 |     maxRows = {1}
 76 |     duration = {6000}
 77 |     hasMoved = {updateInfos}
 78 |     started = {()=>{
 79 |       console.log('react advanced news ticker just started!');
 80 |     }}
 81 |     paused = {()=>{
 82 |       console.log('react advanced news ticker has been paused.');
 83 |     }}>
 84 |     <div>Etiam imperdiet volutpat libero eu tristique.</div>
 85 |     <div>Curabitur porttitor ante eget hendrerit adipiscing.</div>
 86 |     <div>Praesent ornare nisl lorem, ut condimentum lectus gravida ut.</div>
 87 |     <div>Nunc ultrices tortor eu massa placerat posuere.</div>
 88 | </NewsTicker>
 89 | ```
 90 | 
 91 | #### 📖 With Methods
 92 | 
 93 | ```JSX
 94 | const newsTickerRef = useRef(null);
 95 | return <>
 96 |   <NewsTicker
 97 |       ref = {newsTickerRef}
 98 |       autoStart = {false}
 99 |       speed = {400}>
100 |       <div>Etiam imperdiet volutpat libero eu tristique.</div>
101 |       <div>Curabitur porttitor ante eget hendrerit adipiscing.</div>
102 |       <div>Praesent ornare nisl lorem, ut condimentum lectus gravida ut.</div>
103 |       <div>Nunc ultrices tortor eu massa placerat posuere.</div>
104 |   </NewsTicker>
105 | 
106 |   <button
107 |     onClick={() => { newsTickerRef.current.start() }}>
108 |     Start
109 |   </button>
110 | 
111 |   <div
112 |     onMouseEnter={() => newsTickerRef.current.pause()}
113 |     onMouseLeave={() => newsTickerRef.current.unPause()}>
114 |      Pause
115 |   </div>
116 | </>
117 | ```
118 | 
119 | ## 📇 Props
120 | 
121 | | Prop           | Usage                                                                                     | Type/Values                          | Default value    |
122 | | -------------- | ----------------------------------------------------------------------------------------- | ------------------------------------ | ---------------- |
123 | | `rowHeight`    | defines the height (in px) of one row                                                     | `int`                                | _22_             |
124 | | `maxRows`      | defines the number of rows displayed at the same time                                     | `int`                                | _3_              |
125 | | `speed`        | defines the animation speed (in ms)of the rows moving up or down                          | `int` _(in ms)_                      | _400_            |
126 | | `duration`     | defines the times (in ms) before the rows automatically move                              | `int` _(in ms)_                      | _2500_           |
127 | | `direction`    | defines the direction of the rows movement                                                | `Directions.UP` _or_ `Directions.DOWN` | _Directions.UP_ |
128 | | `autoStart`    | enable/disable auto start on load                                                         | `bool`                               | _true_           |
129 | | `pauseOnHover` | enable/disable pause when mouse hovers the newsTicker element                             | `bool`                               | _true_           |
130 | | `className`    | for define className of newsTicker's ul element                                           | `bool`                               | _true_           |
131 | | `id`           | for define id of newsTicker's ul element                                                  | `bool`                               | _""_             |
132 | | `style`        | for styling newsTicker's ul element                                                       | `object`                             | _{}_             |
133 | | `hasMoved`     | `callback` called at the end of every movement animation                                  | `function`                           |
134 | | `movingUp`     | `callback` called before launching `moving up` action                                     | `function`                           |
135 | | `movingDown`   | `callback` called before launching `moving down` action                                   | `function`                           |
136 | | `start`        | `callback` called on `start` action                                                       | `function`                           |
137 | | `stop`         | `callback` called on `stop` action                                                        | `function`                           |
138 | | `pause`        | `callback` called on `pause` action (triggered on `onMouseEnter` if `pauseOnHover=true `) | `function`                           |
139 | | `unpause`      | called on `unpause` action (triggered on `onMouseLeave` if `pauseOnHover=true `)          | `function`                           |
140 | 
141 | ## 📇 Methods
142 | 
143 | After creating NewsTicker component with ref, methods are called with `ref.current.methodName()`
144 | 
145 | Example :
146 | 
147 | ```javascript
148 | ref.current.stop();
149 | ref.current.start();
150 | ref.current.move();
151 | ref.current.getState();
152 | ref.current.pause();
153 | ```
154 | 
155 | #### 📜 Method List
156 | 
157 | | Method     | Action                                                                                                                                                                            |
158 | | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
159 | | `start`    | starts moving newsTicker elements                                                                                                                                                 |
160 | | `stop`     | stops moving newsTicker elements                                                                                                                                                  |
161 | | `getState` | returns current state: `TickerStates.Stopped` = stopped, `TickerStates.Running` = started, `TickerStates.Paused` = paused (and started)                                           |
162 | | `pause`    | pauses newsTicker elements without stopping them - the newsTicker has to be started to be able to pause it (the `pause` method is called on `onMouseEnter` if `pauseOnHover` = true) |
163 | | `unpause`  | unpauses newsTicker elements - the newsTicker has to be started & paused to be able to unpause it (the `unpause` method is called on `onMouseLeave` if `pauseOnHover` = true)     |
164 | | `moveDown` | moves elements down                                                                                                                                                               |
165 | | `moveUp`   | moves elements up                                                                                                                                                                 |
166 | | `moveNext` | moves up or down according to the current `direction` option                                                                                                                      |
167 | | `movePrev` | moves up or down according to the current `direction` option                                                                                                                      |
168 | | `move`     | equivalent to `moveNext`, but will not move if `paused`                                                                                                                           |
169 | 
170 | ## Author
171 | 
172 | 👤 **Ahmet Can Aydemir**
173 | 
174 | - Website: https://www.ahmetcanaydemir.com
175 | - Twitter: [@ahmetcnaydemir](https://twitter.com/ahmetcnaydemir)
176 | - Github: [@ahmetcanaydemir](https://github.com/ahmetcanaydemir)
177 | - LinkedIn: [@ahmetcanaydemir](https://linkedin.com/in/ahmetcanaydemir)
178 | 
179 | ## 👍 Contribute
180 | 
181 | Contributions, issues and feature requests are welcome!<br />Feel free to check [issues page](https://github.com/ahmetcanaydemir/react-advanced-news-ticker/issues).
182 | 
183 | ## 📝 License
184 | 
185 | This project based on [risq](https://github.com/risq)'s [JQuery Advanced News Ticker](https://github.com/risq/jquery-advanced-news-ticker).<br />
186 | This project is [GPL-2.0](https://github.com/ahmetcanaydemir/react-advanced-news-ticker/blob/master/LICENSE) licensed.
187 | 


--------------------------------------------------------------------------------
/dist/index.js:
--------------------------------------------------------------------------------
  1 | "use strict";
  2 | 
  3 | Object.defineProperty(exports, "__esModule", {
  4 |   value: true
  5 | });
  6 | exports.TickerStates = exports.Directions = undefined;
  7 | 
  8 | var _createClass = function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();
  9 | 
 10 | var _react = require("react");
 11 | 
 12 | var _react2 = _interopRequireDefault(_react);
 13 | 
 14 | var _propTypes = require("prop-types");
 15 | 
 16 | var _propTypes2 = _interopRequireDefault(_propTypes);
 17 | 
 18 | function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 19 | 
 20 | function _toConsumableArray(arr) { if (Array.isArray(arr)) { for (var i = 0, arr2 = Array(arr.length); i < arr.length; i++) { arr2[i] = arr[i]; } return arr2; } else { return Array.from(arr); } }
 21 | 
 22 | function _asyncToGenerator(fn) { return function () { var gen = fn.apply(this, arguments); return new Promise(function (resolve, reject) { function step(key, arg) { try { var info = gen[key](arg); var value = info.value; } catch (error) { reject(error); return; } if (info.done) { resolve(value); } else { return Promise.resolve(value).then(function (value) { step("next", value); }, function (err) { step("throw", err); }); } } return step("next"); }); }; }
 23 | 
 24 | function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
 25 | 
 26 | function _possibleConstructorReturn(self, call) { if (!self) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return call && (typeof call === "object" || typeof call === "function") ? call : self; }
 27 | 
 28 | function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function, not " + typeof superClass); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, enumerable: false, writable: true, configurable: true } }); if (superClass) Object.setPrototypeOf ? Object.setPrototypeOf(subClass, superClass) : subClass.__proto__ = superClass; }
 29 | 
 30 | var Directions = exports.Directions = Object.freeze({ UP: 1, DOWN: 2 });
 31 | var TickerStates = exports.TickerStates = Object.freeze({ Stopped: 0, Running: 1, Paused: 2 });
 32 | 
 33 | var NewsTicker = function (_Component) {
 34 |   _inherits(NewsTicker, _Component);
 35 | 
 36 |   function NewsTicker(props) {
 37 |     _classCallCheck(this, NewsTicker);
 38 | 
 39 |     var _this = _possibleConstructorReturn(this, (NewsTicker.__proto__ || Object.getPrototypeOf(NewsTicker)).call(this, props));
 40 | 
 41 |     _this.state = {
 42 |       speed: _this.props.speed,
 43 |       currState: 0,
 44 |       paused: 0,
 45 |       moving: 0,
 46 |       moveInterval: null,
 47 |       items: Array.isArray(_this.props.children) && _this.props.children || [_this.props.children]
 48 |     };
 49 | 
 50 |     _this.element = _react2.default.createRef();
 51 |     return _this;
 52 |   }
 53 | 
 54 |   _createClass(NewsTicker, [{
 55 |     key: "componentDidMount",
 56 |     value: function componentDidMount() {
 57 |       this.init();
 58 |     }
 59 |   }, {
 60 |     key: "componentWillUnmount",
 61 |     value: function componentWillUnmount() {
 62 |       if (this.state.moveInterval) clearInterval(this.state.moveInterval);
 63 |     }
 64 |   }, {
 65 |     key: "init",
 66 |     value: function init() {
 67 |       this.element.current.style.height = this.props.rowHeight * this.props.maxRows + "px";
 68 |       this.element.current.style.overflow = "hidden";
 69 |       this.checkSpeed();
 70 | 
 71 |       if (this.props.autoStart) this.start();
 72 |     }
 73 |   }, {
 74 |     key: "start",
 75 |     value: function start() {
 76 |       var _this2 = this;
 77 | 
 78 |       if (this.state.currState) return;
 79 | 
 80 |       this.setState(function (_, props) {
 81 |         return {
 82 |           currState: 1,
 83 |           items: Array.isArray(_this2.props.children) && _this2.props.children || [_this2.props.children]
 84 |         };
 85 |       }, function () {
 86 |         _this2.resetInterval();
 87 |         _this2.props.started();
 88 |       });
 89 |     }
 90 |   }, {
 91 |     key: "stop",
 92 |     value: function stop() {
 93 |       var _this3 = this;
 94 | 
 95 |       if (!this.state.currState) return;
 96 | 
 97 |       clearInterval(this.state.moveInterval);
 98 |       this.setState({ currState: 0 }, function () {
 99 |         return _this3.props.stopped();
100 |       });
101 |     }
102 |   }, {
103 |     key: "resetInterval",
104 |     value: function resetInterval() {
105 |       var _this4 = this;
106 | 
107 |       if (!this.state.currState) return;
108 |       clearInterval(this.state.moveInterval);
109 |       this.setState({
110 |         moveInterval: setInterval(function () {
111 |           return _this4.move();
112 |         }, this.props.duration)
113 |       });
114 |     }
115 |   }, {
116 |     key: "move",
117 |     value: function move() {
118 |       if (!this.state.paused) this.moveNext();
119 |     }
120 |   }, {
121 |     key: "moveNext",
122 |     value: function moveNext() {
123 |       if (this.props.direction === Directions.DOWN) this.moveDown();else this.moveUp();
124 |     }
125 |   }, {
126 |     key: "movePrev",
127 |     value: function movePrev() {
128 |       if (this.props.direction === Directions.DOWN) this.moveUp();else this.moveDown();
129 |     }
130 |   }, {
131 |     key: "pause",
132 |     value: function pause() {
133 |       var _this5 = this;
134 | 
135 |       if (!this.state.paused) this.setState({ paused: 1 }, function () {
136 |         return _this5.props.paused();
137 |       });
138 |     }
139 |   }, {
140 |     key: "unPause",
141 |     value: function unPause() {
142 |       var _this6 = this;
143 | 
144 |       if (this.state.paused) {
145 |         this.setState({ paused: 0 }, function () {
146 |           return _this6.props.unPaused();
147 |         });
148 |       }
149 |     }
150 |   }, {
151 |     key: "_handleDownAnimation",
152 |     value: function () {
153 |       var _ref = _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee2(newList) {
154 |         var _this7 = this;
155 | 
156 |         var firsLiEl, speed;
157 |         return regeneratorRuntime.wrap(function _callee2$(_context2) {
158 |           while (1) {
159 |             switch (_context2.prev = _context2.next) {
160 |               case 0:
161 |                 firsLiEl = this.element.current.children[0];
162 |                 speed = this.props.speed;
163 |                 _context2.next = 4;
164 |                 return this.setState({ items: newList });
165 | 
166 |               case 4:
167 |                 // Hide first li element at up
168 |                 firsLiEl.style.cssText = "margin: -" + this.props.rowHeight + "px 0 0 0";
169 | 
170 |                 // First element will go down in speed ms
171 |                 setTimeout(function () {
172 |                   firsLiEl.style.cssText = "margin: 0;transition: margin " + speed + "ms;";
173 |                 }, 0);
174 | 
175 |                 // Wait for speed ms and add last element to beginning of the list.
176 |                 _context2.next = 8;
177 |                 return new Promise(function (resolve) {
178 |                   return setTimeout(_asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee() {
179 |                     return regeneratorRuntime.wrap(function _callee$(_context) {
180 |                       while (1) {
181 |                         switch (_context.prev = _context.next) {
182 |                           case 0:
183 |                             newList.pop();
184 |                             _context.next = 3;
185 |                             return _this7.setState({ items: newList });
186 | 
187 |                           case 3:
188 | 
189 |                             resolve();
190 | 
191 |                           case 4:
192 |                           case "end":
193 |                             return _context.stop();
194 |                         }
195 |                       }
196 |                     }, _callee, _this7);
197 |                   })), speed);
198 |                 });
199 | 
200 |               case 8:
201 |               case "end":
202 |                 return _context2.stop();
203 |             }
204 |           }
205 |         }, _callee2, this);
206 |       }));
207 | 
208 |       function _handleDownAnimation(_x) {
209 |         return _ref.apply(this, arguments);
210 |       }
211 | 
212 |       return _handleDownAnimation;
213 |     }()
214 |   }, {
215 |     key: "moveDown",
216 |     value: function () {
217 |       var _ref3 = _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee3() {
218 |         var itemsCopy;
219 |         return regeneratorRuntime.wrap(function _callee3$(_context3) {
220 |           while (1) {
221 |             switch (_context3.prev = _context3.next) {
222 |               case 0:
223 |                 if (!this.state.moving) {
224 |                   _context3.next = 2;
225 |                   break;
226 |                 }
227 | 
228 |                 return _context3.abrupt("return");
229 | 
230 |               case 2:
231 |                 _context3.next = 4;
232 |                 return this.setState({ moving: 1 });
233 | 
234 |               case 4:
235 |                 this.props.movingDown();
236 | 
237 |                 itemsCopy = [].concat(_toConsumableArray(this.state.items));
238 | 
239 |                 itemsCopy.unshift(itemsCopy[itemsCopy.length - 1]);
240 | 
241 |                 _context3.next = 9;
242 |                 return this._handleDownAnimation(itemsCopy);
243 | 
244 |               case 9:
245 |                 _context3.next = 11;
246 |                 return this.setState({ moving: 0 });
247 | 
248 |               case 11:
249 |                 this.props.hasMoved();
250 | 
251 |               case 12:
252 |               case "end":
253 |                 return _context3.stop();
254 |             }
255 |           }
256 |         }, _callee3, this);
257 |       }));
258 | 
259 |       function moveDown() {
260 |         return _ref3.apply(this, arguments);
261 |       }
262 | 
263 |       return moveDown;
264 |     }()
265 |   }, {
266 |     key: "_handleUpAnimation",
267 |     value: function () {
268 |       var _ref4 = _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee5(newList) {
269 |         var _this8 = this;
270 | 
271 |         var firsLiEl;
272 |         return regeneratorRuntime.wrap(function _callee5$(_context5) {
273 |           while (1) {
274 |             switch (_context5.prev = _context5.next) {
275 |               case 0:
276 |                 firsLiEl = this.element.current.children[0];
277 |                 _context5.next = 3;
278 |                 return this.setState({ items: newList });
279 | 
280 |               case 3:
281 | 
282 |                 // First element will go up rowHeight px in speed ms
283 |                 setTimeout(function () {
284 |                   return firsLiEl.style.cssText = "margin: -" + _this8.props.rowHeight + "px 0 0 0; transition: all " + _this8.props.speed + "ms;";
285 |                 }, 0);
286 | 
287 |                 // Wait for speed ms and send first element to end of the list.
288 |                 // After that get first list element back to margin 0.
289 |                 _context5.next = 6;
290 |                 return new Promise(function (resolve) {
291 |                   return setTimeout(_asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee4() {
292 |                     return regeneratorRuntime.wrap(function _callee4$(_context4) {
293 |                       while (1) {
294 |                         switch (_context4.prev = _context4.next) {
295 |                           case 0:
296 |                             newList.shift();
297 |                             _context4.next = 3;
298 |                             return _this8.setState({ items: newList });
299 | 
300 |                           case 3:
301 |                             firsLiEl.style.cssText = "margin: 0";
302 |                             resolve();
303 | 
304 |                           case 5:
305 |                           case "end":
306 |                             return _context4.stop();
307 |                         }
308 |                       }
309 |                     }, _callee4, _this8);
310 |                   })), _this8.props.speed);
311 |                 });
312 | 
313 |               case 6:
314 |               case "end":
315 |                 return _context5.stop();
316 |             }
317 |           }
318 |         }, _callee5, this);
319 |       }));
320 | 
321 |       function _handleUpAnimation(_x2) {
322 |         return _ref4.apply(this, arguments);
323 |       }
324 | 
325 |       return _handleUpAnimation;
326 |     }()
327 |   }, {
328 |     key: "moveUp",
329 |     value: function () {
330 |       var _ref6 = _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee6() {
331 |         var itemsCopy;
332 |         return regeneratorRuntime.wrap(function _callee6$(_context6) {
333 |           while (1) {
334 |             switch (_context6.prev = _context6.next) {
335 |               case 0:
336 |                 if (!this.state.moving) {
337 |                   _context6.next = 2;
338 |                   break;
339 |                 }
340 | 
341 |                 return _context6.abrupt("return");
342 | 
343 |               case 2:
344 |                 _context6.next = 4;
345 |                 return this.setState({ moving: 1 });
346 | 
347 |               case 4:
348 |                 this.props.movingUp();
349 | 
350 |                 itemsCopy = [].concat(_toConsumableArray(this.state.items));
351 | 
352 |                 itemsCopy.push(itemsCopy[0]);
353 | 
354 |                 _context6.next = 9;
355 |                 return this._handleUpAnimation(itemsCopy);
356 | 
357 |               case 9:
358 |                 _context6.next = 11;
359 |                 return this.setState({ moving: 0 });
360 | 
361 |               case 11:
362 |                 this.props.hasMoved();
363 | 
364 |               case 12:
365 |               case "end":
366 |                 return _context6.stop();
367 |             }
368 |           }
369 |         }, _callee6, this);
370 |       }));
371 | 
372 |       function moveUp() {
373 |         return _ref6.apply(this, arguments);
374 |       }
375 | 
376 |       return moveUp;
377 |     }()
378 |   }, {
379 |     key: "getState",
380 |     value: function getState() {
381 |       if (this.state.paused) return TickerStates.Paused;else return this.state.currState ? TickerStates.Running : TickerStates.Stopped;
382 |     }
383 |   }, {
384 |     key: "checkSpeed",
385 |     value: function checkSpeed() {
386 |       if (this.props.duration < this.state.speed + 25) this.setState(function (_, props) {
387 |         return { speed: props.duration - 25 };
388 |       });
389 |     }
390 |   }, {
391 |     key: "prevButtonClick",
392 |     value: function prevButtonClick() {
393 |       this.movePrev();
394 |       this.resetInterval();
395 |     }
396 |   }, {
397 |     key: "nextButtonClick",
398 |     value: function nextButtonClick() {
399 |       this.moveNext();
400 |       this.resetInterval();
401 |     }
402 |   }, {
403 |     key: "startButtonClick",
404 |     value: function startButtonClick() {
405 |       this.start();
406 |     }
407 |   }, {
408 |     key: "stopButtonClick",
409 |     value: function stopButtonClick() {
410 |       this.stop();
411 |     }
412 |   }, {
413 |     key: "render",
414 |     value: function render() {
415 |       var _this9 = this;
416 | 
417 |       return _react2.default.createElement(
418 |         "ul",
419 |         {
420 |           className: this.props.className,
421 |           id: this.props.id,
422 |           style: this.props.style,
423 |           ref: this.element,
424 |           onMouseEnter: function onMouseEnter() {
425 |             _this9.props.pauseOnHover && _this9.state.currState && _this9.pause();
426 |           },
427 |           onMouseLeave: function onMouseLeave() {
428 |             _this9.props.pauseOnHover && _this9.state.currState && _this9.unPause();
429 |           } },
430 |         this.state.items && this.state.items.map(function (item, index) {
431 |           return _react2.default.createElement(
432 |             "li",
433 |             { key: index },
434 |             item
435 |           );
436 |         })
437 |       );
438 |     }
439 |   }]);
440 | 
441 |   return NewsTicker;
442 | }(_react.Component);
443 | 
444 | NewsTicker.propTypes = {
445 |   rowHeight: _propTypes2.default.number,
446 |   maxRows: _propTypes2.default.number,
447 |   children: _propTypes2.default.oneOfType([_propTypes2.default.arrayOf(_propTypes2.default.node), _propTypes2.default.node]).isRequired,
448 |   speed: _propTypes2.default.number,
449 |   duration: _propTypes2.default.number,
450 |   direction: _propTypes2.default.oneOf([Directions.UP, Directions.DOWN]),
451 |   autoStart: _propTypes2.default.bool,
452 |   pauseOnHover: _propTypes2.default.bool,
453 |   className: _propTypes2.default.string,
454 |   id: _propTypes2.default.string,
455 |   style: _propTypes2.default.object,
456 |   hasMoved: _propTypes2.default.func,
457 |   movingUp: _propTypes2.default.func,
458 |   movingDown: _propTypes2.default.func,
459 |   started: _propTypes2.default.func,
460 |   stopped: _propTypes2.default.func,
461 |   paused: _propTypes2.default.func,
462 |   unPaused: _propTypes2.default.func
463 | };
464 | NewsTicker.defaultProps = {
465 |   rowHeight: 22,
466 |   children: [],
467 |   maxRows: 3,
468 |   speed: 400,
469 |   duration: 2500,
470 |   direction: Directions.UP,
471 |   autoStart: true,
472 |   pauseOnHover: true,
473 |   className: "",
474 |   style: {},
475 |   id: "",
476 |   hasMoved: function hasMoved() {},
477 |   movingUp: function movingUp() {},
478 |   movingDown: function movingDown() {},
479 |   started: function started() {},
480 |   stopped: function stopped() {},
481 |   paused: function paused() {},
482 |   unPaused: function unPaused() {}
483 | };
484 | exports.default = NewsTicker;


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 | GNU GENERAL PUBLIC LICENSE
  2 |                        Version 2, June 1991
  3 | 
  4 |  Copyright (C) 1989, 1991 Free Software Foundation, Inc., <http://fsf.org/>
  5 |  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  6 |  Everyone is permitted to copy and distribute verbatim copies
  7 |  of this license document, but changing it is not allowed.
  8 | 
  9 |                             Preamble
 10 | 
 11 |   The licenses for most software are designed to take away your
 12 | freedom to share and change it.  By contrast, the GNU General Public
 13 | License is intended to guarantee your freedom to share and change free
 14 | software--to make sure the software is free for all its users.  This
 15 | General Public License applies to most of the Free Software
 16 | Foundation's software and to any other program whose authors commit to
 17 | using it.  (Some other Free Software Foundation software is covered by
 18 | the GNU Lesser General Public License instead.)  You can apply it to
 19 | your programs, too.
 20 | 
 21 |   When we speak of free software, we are referring to freedom, not
 22 | price.  Our General Public Licenses are designed to make sure that you
 23 | have the freedom to distribute copies of free software (and charge for
 24 | this service if you wish), that you receive source code or can get it
 25 | if you want it, that you can change the software or use pieces of it
 26 | in new free programs; and that you know you can do these things.
 27 | 
 28 |   To protect your rights, we need to make restrictions that forbid
 29 | anyone to deny you these rights or to ask you to surrender the rights.
 30 | These restrictions translate to certain responsibilities for you if you
 31 | distribute copies of the software, or if you modify it.
 32 | 
 33 |   For example, if you distribute copies of such a program, whether
 34 | gratis or for a fee, you must give the recipients all the rights that
 35 | you have.  You must make sure that they, too, receive or can get the
 36 | source code.  And you must show them these terms so they know their
 37 | rights.
 38 | 
 39 |   We protect your rights with two steps: (1) copyright the software, and
 40 | (2) offer you this license which gives you legal permission to copy,
 41 | distribute and/or modify the software.
 42 | 
 43 |   Also, for each author's protection and ours, we want to make certain
 44 | that everyone understands that there is no warranty for this free
 45 | software.  If the software is modified by someone else and passed on, we
 46 | want its recipients to know that what they have is not the original, so
 47 | that any problems introduced by others will not reflect on the original
 48 | authors' reputations.
 49 | 
 50 |   Finally, any free program is threatened constantly by software
 51 | patents.  We wish to avoid the danger that redistributors of a free
 52 | program will individually obtain patent licenses, in effect making the
 53 | program proprietary.  To prevent this, we have made it clear that any
 54 | patent must be licensed for everyone's free use or not licensed at all.
 55 | 
 56 |   The precise terms and conditions for copying, distribution and
 57 | modification follow.
 58 | 
 59 |                     GNU GENERAL PUBLIC LICENSE
 60 |    TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
 61 | 
 62 |   0. This License applies to any program or other work which contains
 63 | a notice placed by the copyright holder saying it may be distributed
 64 | under the terms of this General Public License.  The "Program", below,
 65 | refers to any such program or work, and a "work based on the Program"
 66 | means either the Program or any derivative work under copyright law:
 67 | that is to say, a work containing the Program or a portion of it,
 68 | either verbatim or with modifications and/or translated into another
 69 | language.  (Hereinafter, translation is included without limitation in
 70 | the term "modification".)  Each licensee is addressed as "you".
 71 | 
 72 | Activities other than copying, distribution and modification are not
 73 | covered by this License; they are outside its scope.  The act of
 74 | running the Program is not restricted, and the output from the Program
 75 | is covered only if its contents constitute a work based on the
 76 | Program (independent of having been made by running the Program).
 77 | Whether that is true depends on what the Program does.
 78 | 
 79 |   1. You may copy and distribute verbatim copies of the Program's
 80 | source code as you receive it, in any medium, provided that you
 81 | conspicuously and appropriately publish on each copy an appropriate
 82 | copyright notice and disclaimer of warranty; keep intact all the
 83 | notices that refer to this License and to the absence of any warranty;
 84 | and give any other recipients of the Program a copy of this License
 85 | along with the Program.
 86 | 
 87 | You may charge a fee for the physical act of transferring a copy, and
 88 | you may at your option offer warranty protection in exchange for a fee.
 89 | 
 90 |   2. You may modify your copy or copies of the Program or any portion
 91 | of it, thus forming a work based on the Program, and copy and
 92 | distribute such modifications or work under the terms of Section 1
 93 | above, provided that you also meet all of these conditions:
 94 | 
 95 |     a) You must cause the modified files to carry prominent notices
 96 |     stating that you changed the files and the date of any change.
 97 | 
 98 |     b) You must cause any work that you distribute or publish, that in
 99 |     whole or in part contains or is derived from the Program or any
100 |     part thereof, to be licensed as a whole at no charge to all third
101 |     parties under the terms of this License.
102 | 
103 |     c) If the modified program normally reads commands interactively
104 |     when run, you must cause it, when started running for such
105 |     interactive use in the most ordinary way, to print or display an
106 |     announcement including an appropriate copyright notice and a
107 |     notice that there is no warranty (or else, saying that you provide
108 |     a warranty) and that users may redistribute the program under
109 |     these conditions, and telling the user how to view a copy of this
110 |     License.  (Exception: if the Program itself is interactive but
111 |     does not normally print such an announcement, your work based on
112 |     the Program is not required to print an announcement.)
113 | 
114 | These requirements apply to the modified work as a whole.  If
115 | identifiable sections of that work are not derived from the Program,
116 | and can be reasonably considered independent and separate works in
117 | themselves, then this License, and its terms, do not apply to those
118 | sections when you distribute them as separate works.  But when you
119 | distribute the same sections as part of a whole which is a work based
120 | on the Program, the distribution of the whole must be on the terms of
121 | this License, whose permissions for other licensees extend to the
122 | entire whole, and thus to each and every part regardless of who wrote it.
123 | 
124 | Thus, it is not the intent of this section to claim rights or contest
125 | your rights to work written entirely by you; rather, the intent is to
126 | exercise the right to control the distribution of derivative or
127 | collective works based on the Program.
128 | 
129 | In addition, mere aggregation of another work not based on the Program
130 | with the Program (or with a work based on the Program) on a volume of
131 | a storage or distribution medium does not bring the other work under
132 | the scope of this License.
133 | 
134 |   3. You may copy and distribute the Program (or a work based on it,
135 | under Section 2) in object code or executable form under the terms of
136 | Sections 1 and 2 above provided that you also do one of the following:
137 | 
138 |     a) Accompany it with the complete corresponding machine-readable
139 |     source code, which must be distributed under the terms of Sections
140 |     1 and 2 above on a medium customarily used for software interchange; or,
141 | 
142 |     b) Accompany it with a written offer, valid for at least three
143 |     years, to give any third party, for a charge no more than your
144 |     cost of physically performing source distribution, a complete
145 |     machine-readable copy of the corresponding source code, to be
146 |     distributed under the terms of Sections 1 and 2 above on a medium
147 |     customarily used for software interchange; or,
148 | 
149 |     c) Accompany it with the information you received as to the offer
150 |     to distribute corresponding source code.  (This alternative is
151 |     allowed only for noncommercial distribution and only if you
152 |     received the program in object code or executable form with such
153 |     an offer, in accord with Subsection b above.)
154 | 
155 | The source code for a work means the preferred form of the work for
156 | making modifications to it.  For an executable work, complete source
157 | code means all the source code for all modules it contains, plus any
158 | associated interface definition files, plus the scripts used to
159 | control compilation and installation of the executable.  However, as a
160 | special exception, the source code distributed need not include
161 | anything that is normally distributed (in either source or binary
162 | form) with the major components (compiler, kernel, and so on) of the
163 | operating system on which the executable runs, unless that component
164 | itself accompanies the executable.
165 | 
166 | If distribution of executable or object code is made by offering
167 | access to copy from a designated place, then offering equivalent
168 | access to copy the source code from the same place counts as
169 | distribution of the source code, even though third parties are not
170 | compelled to copy the source along with the object code.
171 | 
172 |   4. You may not copy, modify, sublicense, or distribute the Program
173 | except as expressly provided under this License.  Any attempt
174 | otherwise to copy, modify, sublicense or distribute the Program is
175 | void, and will automatically terminate your rights under this License.
176 | However, parties who have received copies, or rights, from you under
177 | this License will not have their licenses terminated so long as such
178 | parties remain in full compliance.
179 | 
180 |   5. You are not required to accept this License, since you have not
181 | signed it.  However, nothing else grants you permission to modify or
182 | distribute the Program or its derivative works.  These actions are
183 | prohibited by law if you do not accept this License.  Therefore, by
184 | modifying or distributing the Program (or any work based on the
185 | Program), you indicate your acceptance of this License to do so, and
186 | all its terms and conditions for copying, distributing or modifying
187 | the Program or works based on it.
188 | 
189 |   6. Each time you redistribute the Program (or any work based on the
190 | Program), the recipient automatically receives a license from the
191 | original licensor to copy, distribute or modify the Program subject to
192 | these terms and conditions.  You may not impose any further
193 | restrictions on the recipients' exercise of the rights granted herein.
194 | You are not responsible for enforcing compliance by third parties to
195 | this License.
196 | 
197 |   7. If, as a consequence of a court judgment or allegation of patent
198 | infringement or for any other reason (not limited to patent issues),
199 | conditions are imposed on you (whether by court order, agreement or
200 | otherwise) that contradict the conditions of this License, they do not
201 | excuse you from the conditions of this License.  If you cannot
202 | distribute so as to satisfy simultaneously your obligations under this
203 | License and any other pertinent obligations, then as a consequence you
204 | may not distribute the Program at all.  For example, if a patent
205 | license would not permit royalty-free redistribution of the Program by
206 | all those who receive copies directly or indirectly through you, then
207 | the only way you could satisfy both it and this License would be to
208 | refrain entirely from distribution of the Program.
209 | 
210 | If any portion of this section is held invalid or unenforceable under
211 | any particular circumstance, the balance of the section is intended to
212 | apply and the section as a whole is intended to apply in other
213 | circumstances.
214 | 
215 | It is not the purpose of this section to induce you to infringe any
216 | patents or other property right claims or to contest validity of any
217 | such claims; this section has the sole purpose of protecting the
218 | integrity of the free software distribution system, which is
219 | implemented by public license practices.  Many people have made
220 | generous contributions to the wide range of software distributed
221 | through that system in reliance on consistent application of that
222 | system; it is up to the author/donor to decide if he or she is willing
223 | to distribute software through any other system and a licensee cannot
224 | impose that choice.
225 | 
226 | This section is intended to make thoroughly clear what is believed to
227 | be a consequence of the rest of this License.
228 | 
229 |   8. If the distribution and/or use of the Program is restricted in
230 | certain countries either by patents or by copyrighted interfaces, the
231 | original copyright holder who places the Program under this License
232 | may add an explicit geographical distribution limitation excluding
233 | those countries, so that distribution is permitted only in or among
234 | countries not thus excluded.  In such case, this License incorporates
235 | the limitation as if written in the body of this License.
236 | 
237 |   9. The Free Software Foundation may publish revised and/or new versions
238 | of the General Public License from time to time.  Such new versions will
239 | be similar in spirit to the present version, but may differ in detail to
240 | address new problems or concerns.
241 | 
242 | Each version is given a distinguishing version number.  If the Program
243 | specifies a version number of this License which applies to it and "any
244 | later version", you have the option of following the terms and conditions
245 | either of that version or of any later version published by the Free
246 | Software Foundation.  If the Program does not specify a version number of
247 | this License, you may choose any version ever published by the Free Software
248 | Foundation.
249 | 
250 |   10. If you wish to incorporate parts of the Program into other free
251 | programs whose distribution conditions are different, write to the author
252 | to ask for permission.  For software which is copyrighted by the Free
253 | Software Foundation, write to the Free Software Foundation; we sometimes
254 | make exceptions for this.  Our decision will be guided by the two goals
255 | of preserving the free status of all derivatives of our free software and
256 | of promoting the sharing and reuse of software generally.
257 | 
258 |                             NO WARRANTY
259 | 
260 |   11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
268 | REPAIR OR CORRECTION.
269 | 
270 |   12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
278 | POSSIBILITY OF SUCH DAMAGES.
279 | 
280 |                      END OF TERMS AND CONDITIONS
281 | 
282 |             How to Apply These Terms to Your New Programs
283 | 
284 |   If you develop a new program, and you want it to be of the greatest
285 | possible use to the public, the best way to achieve this is to make it
286 | free software which everyone can redistribute and change under these terms.
287 | 
288 |   To do so, attach the following notices to the program.  It is safest
289 | to attach them to the start of each source file to most effectively
290 | convey the exclusion of warranty; and each file should have at least
291 | the "copyright" line and a pointer to where the full notice is found.
292 | 
293 |     {description}
294 |     Copyright (C) {year}  {fullname}
295 | 
296 |     This program is free software; you can redistribute it and/or modify
297 |     it under the terms of the GNU General Public License as published by
298 |     the Free Software Foundation; either version 2 of the License, or
299 |     (at your option) any later version.
300 | 
301 |     This program is distributed in the hope that it will be useful,
302 |     but WITHOUT ANY WARRANTY; without even the implied warranty of
303 |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
304 |     GNU General Public License for more details.
305 | 
306 |     You should have received a copy of the GNU General Public License along
307 |     with this program; if not, write to the Free Software Foundation, Inc.,
308 |     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
309 | 
310 | Also add information on how to contact you by electronic and paper mail.
311 | 
312 | If the program is interactive, make it output a short notice like this
313 | when it starts in an interactive mode:
314 | 
315 |     Gnomovision version 69, Copyright (C) year name of author
316 |     Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
317 |     This is free software, and you are welcome to redistribute it
318 |     under certain conditions; type `show c' for details.
319 | 
320 | The hypothetical commands `show w' and `show c' should show the appropriate
321 | parts of the General Public License.  Of course, the commands you use may
322 | be called something other than `show w' and `show c'; they could even be
323 | mouse-clicks or menu items--whatever suits your program.
324 | 
325 | You should also get your employer (if you work as a programmer) or your
326 | school, if any, to sign a "copyright disclaimer" for the program, if
327 | necessary.  Here is a sample; alter the names:
328 | 
329 |   Yoyodyne, Inc., hereby disclaims all copyright interest in the program
330 |   `Gnomovision' (which makes passes at compilers) written by James Hacker.
331 | 
332 |   {signature of Ty Coon}, 1 April 1989
333 |   Ty Coon, President of Vice
334 | 
335 | This General Public License does not permit incorporating your program into
336 | proprietary programs.  If your program is a subroutine library, you may
337 | consider it more useful to permit linking proprietary applications with the
338 | library.  If this is what you want to do, use the GNU Lesser General
339 | Public License instead of this License.
340 | 


--------------------------------------------------------------------------------