Skip to content

Latest commit

 

History

History
81 lines (77 loc) · 1.67 KB

README.md

File metadata and controls

81 lines (77 loc) · 1.67 KB

sizeInPage.js

Is a JavaScript plugin that helps you better design websites

How

Used only for sizing and displays width, height and breakpoint
so you can work on sizing better

How to use

Just link the sizeInPage.js file to your page and then call the startSizeInPage function

<script src="sizeInPage.js"></script>
  • startSizeInPage()

Options

+ theme (Set General theme)
+ align (Set the location on the page)
+ opacity (Adjust transparency)
+ help (Show help)
Use options :
To use the options, we must pass them as an object and
as an argument to the startSizeInPage() function.
example :

startSizeInPage({
 theme: 'dark',
 align: 'bl',
 opacity: '1',
 help:'en'
})

Options values

theme


theme: 'dark' | 'theme': light
(theme: dark is enabled by default)
Example of use: ```javascript startSizeInPage({ theme: 'dark' }) ``` or ```javascript startSizeInPage({ theme: 'light' }) ```

align


align : 'tl' | 'tr' | 'bl' | 'br' | 'center'
(align: 'bl' is enabled by default)
(Values ​​stand for directions, example: tr = top right)
Example of use: ```javascript startSizeInPage({ align: 'tl' (example) }) ```

opacity


To set the opacity and its value is between 0 and 1
(opacity: 1 is enabled by default)
Example of use: ```javascript startSizeInPage({ opacity: '0.8' (example) }) ```

help


help : 'en' | 'fa' To display the plugin guide (en = in English , fa = in Persian)
(help: 'none' is enabled by default)
Example of use: ``` javascript startSizeInPage({ help:'en' }) ```