mydomlib
v1.0.0
Published
MyDOMLib
Downloads
1
Readme
MyDOMLib
Hello! Welcome to MyLib! Note: This is a work in progress, so new features are yet to come!
While there are a few side functions, MyDOMLib is mainly made for DOM manipulation.
Documentation
ErrorCatch(code, htmlElement, type, replace)
Parameter(s):
code
: The code you want to analyze. It can either be a function, string (" "), or a multi-line string (``).htmlElement
: The HTML element(s) that will display the error. To use "_" to select the element, just do _("your element").elementSelected.type
: The type you want to edit the HTML element. It can be either text or html.replace
: If you want to replace the HTML element's current text content or inner HTML, set it to true. If you don't, set it to false.
Example:
<!DOCTYPE html>
<html>
<head>
<!-- Assuming you have the library file -->
<script src="myLib.js"></script>
</head>
<body>
<p id="errorDisplay"></p>
<script>
// With a string:
new ErrorCatch("function() {}", _("#errorDisplay").elementSelected, "text", true);
// This will have the error "SyntaxError: Function statements must have a name."
// With a function name:
new ErrorCatch(exampleFunction, _("#errorDisplay").elementSelected, "text", true);
function exampleFunction() {
console.log("hi");
wefi
}
// This will have the error "ReferenceError: Can't find variable: wefi"
// With a multi-line string:
new ErrorCatch(`
function hi() {
var qwerty =
}
`, _("#errorDisplay").elementSelected, "text", true);
// This will have the error "SyntaxError: Unexpected identifier 'qwerty'"
// Note: You will need to have ES6 enabled to have multi-line comments.
</script>
</body>
</html>
_(selection)
Parameter(s):
-selection
:
The HTML element you want to select. It can start with .
when you want to select a class, #
for when you want to select an ID, and use start with nothing if you are selecting elements.
Example:
<!DOCTYPE html>
<html>
<head>
<!--Assuming you have the library file-->
<script src="myLib.js"></script>
<style>
.hello {
color:red;
}
</style>
</head>
<body>
<div id="myDiv">
This is a div with the ID of "myDiv"
</div>
<p class="hello">This is a p element with the class of "hello"</p>
<p class="hello">This is a p element with the class of "hello"</p>
<p class="hello">This is a p element with the class of "hello"</p>
<p class="hello">This is a p element with the class of "hello"</p>
<p class="hello">This is a p element with the class of "hello"</p>
<img id="picture" src="https://upload.wikimedia.org/wikipedia/commons/1/15/Cat_August_2010-4.jpg" alt="Cat August 2010-4.jpg" width="300">
<img id="picture2" src="https://upload.wikimedia.org/wikipedia/commons/c/c8/Black_Labrador_Retriever_-_Male_IMG_3323.jpg" width="300">
<div id="appendDiv"></div>
<script>
//Here it returns the element with the id of "myDiv":
_("#myDiv").el;
//Here it edit's the text element:
_("#myDiv").edit("text", "This is an edited div with the ID of \"myDiv\"");
//Here it changes the src of 2 elements in one line:
_("#picture").edit("src", "https://upload.wikimedia.org/wikipedia/commons/c/c8/Black_Labrador_Retriever_-_Male_IMG_3323.jpg")._("#picture2").edit("src", "https://upload.wikimedia.org/wikipedia/commons/1/15/Cat_August_2010-4.jpg");
//This shows that you can chain.
//Here it changes the alt of 2 elements in 2 lines:
_("#picture").edit("alt", "Black Labrador Retriever");
_("#picture2").edit("alt", "Cat August 2010-4.jpg");
//Here it collects all the elements with the class of "hello" and edit's their color and gives them a border:
_(".hello").setStyle("color", "green").setStyle("border", "10px ridge black");
//Here it makes a totally new element and appends it to an element with the id of "appendDiv" with a border:
var newElement = createElem("p").setID("divP").setClass("divP").setClass("divP2").result;
_("#divP").edit("text", "Hello! This is a \"p\" element inside a ");
_(".divP").edit("text", "div!", true);
_(".divP2").setStyle("margin-left", "10px");
_("#appendDiv").append(newElement).setStyle("border", "10px ridge red");
</script>
</body>
</html>
Returned Variables:
-el
:
By using "_('whateverYouWantToSelect').el" it will return the element(s) that has/have been selected.
-alt
:
By using "_('whateverYouWantToSelect').alt", you will get the alt(s) of the element(s) selected.
-src
:
By using "_('whateverYouWantToSelect').src", you will get the src(s) of the elements(s) selected.
-html
:
By using "_('whateverYouWantToSelect').html", you will get the innerHTML(s) of the element(s) selected.
-width
:
By using "_('whateverYouWantToSelect').width", you will get the width(s) of the element(s) selected.
-height
:
By using "_('whateverYouWantToSelect').height", you will get the height(s) of the element(s) selected.
-text
:
By using "_('whateverYouWantToSelect').text", you will get the textContent(s) of the element(s) selected.
-edit
:
By using "_('whateverYouWantToSelect').edit", you will have the edit function returned to you.
edit(whatToEdit, whatToEditTo, add)
Parameter(s):
-whatToEdit
:
Basically, what do you want to edit about the element(s). Can either be "text", "html", "src", or "alt".
-whatToEditTo
:
What you want it to become. Can be a string, function, or a multi-line string.
-add
:
True if you want to add on to the current value, false if you don't.
Back to the returned variables of _.
-addClass
:
By using "_('whateverYouWantToSelect').addClass", you will have a function that adds a class to the element(s) selected. The only parameter is the class to set to.
-removeClass
:
By using "_('whateverYouWantToSelect').removeClass", you will have a function that removes a class from the element(s) selected. No parameters needed.
-setID
:
By using "_('whateverYouWantToSelect').setID", you will have a function that sets the ID of the element(s) selected.
-removeID
:
By using "_('whateverYouWantToSelect').removeID", you will have a function that removes the ID of the element(s) selected.
-append
:
By using "_('whateverYouWantToSelect').append", you will have a function that appends an element to the element(s) selected.
-setStyle
:
By using "_('whateverYouWantToSelect').setStyle", you will have a function that adds CSS style to the selected element(s).
-_
:
By using this function, you are basically repeating the entire _ function.