Compare commits

...

15 Commits
v1.02 ... main

16 changed files with 400 additions and 223 deletions

View File

@ -1,4 +1,14 @@
# DS2 Core
# DS2-core
DS2-core is a lightweight PugJS-based framework for building design systems.
The design system compiles to mostly pure HTML, SCSS and JavaScript. There are a few enhanced parts that use PHP in order to handle non-critical tasks Zip files on the fly to collect component JavaScript and SCSS. PugJS is used because it can handle some of the automation such as creating includes making components extremely modular.
## Requirements
The requirements for ds2-core are pretty light. You'll want to be able to process [PugJS](https://pugjs.org/api/getting-started.html) (formerly Jade) and [SCSS](https://sass-lang.com/documentation/) -- and that's about it.
For our own design system, we use ds2-core with [Prepros](https://prepros.io) (which you can use the Free Unlimited Trial for, but why not splurge and spend the $30USD to support the developer and skip the nags). On MacOS, you could also use [CodeKit](https://codekitapp.com/).
Alternatively, if you have pre-processor pipelines for Pug and SCSS, which you can install using npm, or any other language you decide to pull in, you can use those to compile if that ends up being easier for you. The framework isn't too picky, so long as things go into the right place.
## "Installation"
@ -11,20 +21,23 @@ src/pg/core/download.php.pug | public
All other pug files should compile to from src/pg/ to a relative path of public/*
## Running the core
functions
### Callback functions
Callback functions can be used in
beforeArticleLoad - called before any patterns are started to load
success - called when loading a pattern is successful if the result is an HTTP 200
afterArticleLoad - called after any patterns are started to load
done - called when the ajax for any pattern is done, whether successful or not. This is a useful place to load any javascript initializations that pattern.
- beforeArticleLoad - called before any patterns have started to load
- success - called when loading a pattern is successful if the result is an HTTP 200
- afterArticleLoad - called after any patterns have started to load
- done - called when the ajax for any pattern is done, whether successful or not. This is a useful place to load any javascript initializations that pattern.
## About the content variable
## Creating an item
The content variable in \_config.pug defines your array of patterns. It is made up of the following attributes:
## The content object
The content variable in \/src\/pg\/_config.pug defines your array of patterns. It is made up of the following attributes:
- name - the hypenated name of the pattern
- status - this should be one of the statuses from your status array
- display - (optional) if present this will be displayed, as is, instead of the name
@ -49,6 +62,42 @@ In your design system implementation,
This will ensure that the .pug file will get processed and the .pp file will be handled as text will get compiled, but they should display correctly and remain in sync while maintaining the minimum number of files.
## Using core code with your own pattern documentation.
Using
---
Creating a new pattern
Begin by creating a folder within your strucutre to hold the pattern. Add the folder to your config file.
Generating css
You've likely created your component's css as an include file beginning with an underscore. create a second file named the same that includes any dependencies (such as breakpoints) that are required to generate your valid css.
You can now include the css in your pattern's index file.
Generating pug
Create a custom tool in prepros, give it a name such as "PP to Pug" set the input extension to .pp and the output extension to .pug and check Process Automatically . The command should be
Mac / Linux
cp {{input}} {{output}}
Windows
copy {{input}} {{output}}
Once you've added the tool, set the output to "relative path" and set the output extension to pug. For each .pp file you may have to check process automatically as it doesn't always identify the new extension.
You will now be able to include the .pp file in your pattern's index file while including the .pug file which will give a compiled version of your component's html.
---
## Troubleshooting
## Credits
This framework includes [PrismJS](https://prismjs.com/) for code syntax highlighting. PrismJS is released under the [MIT license](https://opensource.org/licenses/MIT)>

View File

@ -191,25 +191,6 @@
},
"buffers":
[
{
"file": "src/js/scaffolding.js",
"settings":
{
"buffer_size": 2622,
"line_ending": "Unix"
},
"undo_stack":
[
[
1,
1,
"revert",
null,
"AgAAAAAAAAAAAAAAAAAAAAAAAAA+CgAALy8gY29yZSBhbmQgcHJpc20KaW1wb3J0ICogYXMgY29yZSBmcm9tICcuL2NvcmUvX2NvcmUuanMnOwppbXBvcnQgKiBhcyBQcmlzbSBmcm9tICIuLi8uLi9ub2RlX21vZHVsZXMvcHJpc21qcy9wcmlzbSI7CmltcG9ydCAiLi4vLi4vbm9kZV9tb2R1bGVzL3ByaXNtanMvcGx1Z2lucy9saW5lLW51bWJlcnMvcHJpc20tbGluZS1udW1iZXJzIjsKaW1wb3J0ICIuLi8uLi9ub2RlX21vZHVsZXMvcHJpc21qcy9wbHVnaW5zL3Rvb2xiYXIvcHJpc20tdG9vbGJhciI7CmltcG9ydCAnLi4vLi4vbm9kZV9tb2R1bGVzL3ByaXNtanMvY29tcG9uZW50cy9wcmlzbS1qc29uJzsKaW1wb3J0ICcuLi8uLi9ub2RlX21vZHVsZXMvcHJpc21qcy9jb21wb25lbnRzL3ByaXNtLXB1Zyc7CmltcG9ydCAnLi4vLi4vbm9kZV9tb2R1bGVzL3ByaXNtanMvY29tcG9uZW50cy9wcmlzbS1zYXNzJzsKCi8vIGltcG9ydCBwYXR0ZXJuIHN0dWZmLgppbXBvcnQgKiBhcyBzdGlja3lub3RlIGZyb20gIi4uL3BnL3BhdHRlcm5zL2NvcmUvc3RpY2t5LW5vdGUvX3N0aWNreS1ub3RlLmpzIjsKaW1wb3J0ICogYXMgc3d0Y2ggICAgICBmcm9tICIuLi9wZy9wYXR0ZXJucy9jb3JlL3N3aXRjaC9fc3dpdGNoLmpzIjsKaW1wb3J0ICogYXMgdGFicyAgICAgICBmcm9tICIuLi9wZy9wYXR0ZXJucy9jb3JlL3RhYnMvX3RhYnMuanMiOwoKLy8gaW5pdCBjb3JlCmNvcmUuaW5pdCh7CglzdWNjZXNzOiAoYSkgPT4geyAKCQl0YWJzLmluaXQoYSk7CgkJc3d0Y2guaW5pdChhKTsKCQlzdGlja3lub3RlLmluaXQoYSk7Cgl9LAoJbm90Rm91bmQ6IChhLCBwYXRoKSA9PiB7CgkJYS5pbm5lckhUTUwgPSBgJHthLmlubmVySFRNTH08ZGl2IGNsYXNzPSdub3RpZmljYXRpb24tYm94IGVycm9yJz48cD5UaGlzIHBhdHRlcm4gYXBwZWFycyB0byBiZSBtaXNzaW5nLjxicj48c21hbGw+KCR7cGF0aH0gcmV0dXJuZWQgaHR0cCBzdGF0dXMgNDA0KTwvc21hbGw+PC9wPjwvZGl2PmA7Cgl9Cn0pOwoKLy8gZGVwcmVjYXRlZCBzd2l0Y2ggaGFuZGxlcgpjb25zdCBmbGlwSW5mb1N3aXRjaCA9IChlLCBzID0gZS5jdXJyZW50VGFyZ2V0KSA9PiB7CgkKCXN3aXRjaChzLmdldEF0dHJpYnV0ZSgiaWQiKSkgewoKCQljYXNlICJkZXByZWNhdGVkIiA6IAoJCQljb3JlLmNvb2tpZS5zZXQoInNob3ctZGVwcmVjYXRlZCIsIHMuZ2V0QXR0cmlidXRlKCJhcmlhLWNoZWNrZWQiKSwgMzAsICIvIik7CgkJCWRvY3VtZW50LnF1ZXJ5U2VsZWN0b3IoIm1haW4iKS5xdWVyeVNlbGVjdG9yQWxsKCJhcnRpY2xlW2RhdGEtc3RhdHVzPWRlcHJlY2F0ZWRdIikuZm9yRWFjaCgoYSkgPT4gewoJCQkJYS5jbGFzc0xpc3RbKCBzLmdldEF0dHJpYnV0ZSgiYXJpYS1jaGVja2VkIikgPT0gInRydWUiID8gImFkZCIgOiAicmVtb3ZlIiApXSgic2hvdy1kZXByZWNhdGVkIik7CgkJCX0pOwoJCWJyZWFrOyAKCgkJY2FzZSAiYnJlYWtwb2ludHMiIDoKCQkJY29uc29sZS5sb2coImhlcmUiKQoJCQljb3JlLmNvb2tpZS5zZXQoInNob3ctYnJlYWtwb2ludHMiLCBzLmdldEF0dHJpYnV0ZSgiYXJpYS1jaGVja2VkIiksIDMwLCAiLyIpOwoJCQlkb2N1bWVudC5xdWVyeVNlbGVjdG9yKCJodG1sIikuY2xhc3NMaXN0Wyggcy5nZXRBdHRyaWJ1dGUoImFyaWEtY2hlY2tlZCIpID09ICJ0cnVlIiA/ICJhZGQiIDogInJlbW92ZSIgKV0oInNob3ctYnJlYWtwb2ludHMiKTsKCQlicmVhazsgCgl9Cgp9CgovLyBjcmVhdGUgYSBwdXJlIEpTIG1vdXNlIGNsaWNrIGV2ZW50CmNvbnN0IGNsaWNrID0gbmV3IE1vdXNlRXZlbnQoJ2NsaWNrJywgewoJdmlldzogd2luZG93LAoJYnViYmxlczogZmFsc2UsCgljYW5jZWxhYmxlOiB0cnVlCn0pOwoKLy8gZ2V0IHRoZSBzd2l0Y2gsIGluaXRpYWxpemUgaXQgYW5kIGFkZCB0aGUgaGFuZGxlcgpsZXQgc3dpdGNoZXMgPSBkb2N1bWVudC5xdWVyeVNlbGVjdG9yKCIuaW5mby1zd2l0Y2hlcyIpOwpzd3RjaC5pbml0KHN3aXRjaGVzKTsKCmxldCBkZXByZWNhdGVkID0gZG9jdW1lbnQucXVlcnlTZWxlY3RvcigiI2RlcHJlY2F0ZWQiKTsKbGV0IGJyZWFrcG9pbnRzID0gZG9jdW1lbnQucXVlcnlTZWxlY3RvcigiI2JyZWFrcG9pbnRzIik7CgpkZXByZWNhdGVkLm9uY2xpY2sgPSBmbGlwSW5mb1N3aXRjaDsKZGVwcmVjYXRlZC5rZXlwcmVzcyA9IGZsaXBJbmZvU3dpdGNoOwpicmVha3BvaW50cy5vbmNsaWNrID0gZmxpcEluZm9Td2l0Y2g7CmJyZWFrcG9pbnRzLmtleXByZXNzID0gZmxpcEluZm9Td2l0Y2g7CgovLyBjaGVjayBhIGNvb2tpZSB0byBnZXQgdGhlIHN3aXRjaCdzIHN0YXRlCmlmIChjb3JlLmNvb2tpZS5nZXQoInNob3ctZGVwcmVjYXRlZCIpID09ICJ0cnVlIikgewoJZGVwcmVjYXRlZC5kaXNwYXRjaEV2ZW50KGNsaWNrKTsKfQppZiAoY29yZS5jb29raWUuZ2V0KCJzaG93LWJyZWFrcG9pbnRzIikgPT0gInRydWUiKSB7CglicmVha3BvaW50cy5kaXNwYXRjaEV2ZW50KGNsaWNrKTsKfQoKLy8ganVzdCBmb3IgZnVuLi4uIFdlJ2xsIHNob3cgZGVwcmVjYXRlZCBpZiB0aGV5IG1hdGNoIHRoZSBwYXRoCi8vIGRvY3VtZW50LnF1ZXJ5U2VsZWN0b3IoYCMke2NvcmUudXJsLnAucmVwbGFjZSgvXC8vZywgIi0iKX1gKS5jbGFzc0xpc3QuYWRkKCJzaG93LWRlcHJlY2F0ZWQiKTsKAAAAAAAAAAA+CgAAAAAAAAAAAAA",
"AQAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAPC/"
]
]
}
],
"build_system": "",
"build_system_choices":
@ -300,12 +281,14 @@
"expanded_folders":
[
"/Users/am/Desktop/ds2-core",
"/Users/am/Desktop/ds2-core/src/pg/patterns",
"/Users/am/Desktop/ds2-core/src/pg/patterns/core"
"/Users/am/Desktop/ds2-core/src/pg/patterns"
],
"file_history":
[
"/Users/am/Desktop/ds2-core/src/js/scaffolding.js",
"/Users/am/Desktop/ds2-core/src/js/core/_core.js",
"/Users/am/Desktop/ds2-core/Readme.md",
"/Users/am/Desktop/ds2-core/src/pg/core/_colour-samples.pug",
"/Users/am/Desktop/ds2-core/src/pg/patterns/core/components/switch/index.pug",
"/Users/am/Desktop/ds2-core/src/pg/patterns/core/components/sticky-note/index.pug",
"/Users/am/Desktop/ds2-core/src/pg/patterns/core/layouts/breakpoints/index.pug",
@ -429,10 +412,7 @@
"/Users/am/Desktop/my DS2/src/pg/patterns/components/tooltip/index.pug",
"/Users/am/Desktop/my DS2/src/pg/patterns/components/link/index.pug",
"/Users/am/Desktop/my DS2/src/pg/patterns/components/progress-bar/index.pug",
"/Users/am/Desktop/my DS2/src/pg/patterns/layouts/main-navigation/index.pug",
"/Users/am/Desktop/my DS2/src/pg/patterns/layouts/breakpoints/index.pug",
"/Users/am/Desktop/my DS2/src/pg/patterns/visual-design/notifications/index.pug",
"/Users/am/Desktop/my DS2/src/pg/patterns/visual-design/spacing/spacing.css"
"/Users/am/Desktop/my DS2/src/pg/patterns/layouts/main-navigation/index.pug"
],
"find":
{
@ -451,6 +431,7 @@
"case_sensitive": false,
"find_history":
[
"oneClickSelect",
"../core/_master-pattern.pug",
"../core",
"hide-deprecated",
@ -519,38 +500,6 @@
{
"sheets":
[
{
"buffer": 0,
"file": "src/js/scaffolding.js",
"selected": true,
"semi_transient": false,
"settings":
{
"buffer_size": 2622,
"regions":
{
},
"selection":
[
[
0,
0
]
],
"settings":
{
"syntax": "Packages/JavaScript/JavaScript.sublime-syntax",
"tab_size": 4,
"translate_tabs_to_spaces": false
},
"translation.x": 0.0,
"translation.y": 365.0,
"zoom_level": 1.0
},
"stack_index": 0,
"stack_multiselect": false,
"type": "text"
}
]
}
],

View File

@ -30,7 +30,7 @@ String.prototype.toPath = function () {
var font = {
size: 0
};
var copyColourFallback = function copyColourFallback(copyInfo, attr) {
var copyFallback = function copyFallback(copyInfo, attr) {
console.log("fallback");
var textArea = document.createElement('textarea');
textArea.value = copyInfo;
@ -75,22 +75,6 @@ var showMessage = function showMessage(m, s) {
status.remove();
}, 1000);
};
var oneClickSelect = function oneClickSelect(e) {
var t = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : e.currentTarget;
// In here, "this" is the element
var range, selection;
if (window.getSelection) {
selection = window.getSelection();
range = document.createRange();
range.selectNodeContents(t);
selection.removeAllRanges();
selection.addRange(range);
} else if (document.body.createTextRange) {
range = document.body.createTextRange();
range.moveToElementText(t);
range.select();
}
};
var getURLVars = function getURLVars() {
var oResult = {};
if (location.search.length > 0) {
@ -144,8 +128,24 @@ module.exports = {
}
return "";
},
remove: function remove(cnane) {
setCookie(cname, "", -1);
remove: function remove(cname) {
module.exports.cookie.set(cname, null, new Date(null));
}
},
oneClickSelect: function oneClickSelect(e) {
var t = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : e.currentTarget;
// In here, "this" is the element
var range, selection;
if (window.getSelection) {
selection = window.getSelection();
range = document.createRange();
range.selectNodeContents(t);
selection.removeAllRanges();
selection.addRange(range);
} else if (document.body.createTextRange) {
range = document.body.createTextRange();
range.moveToElementText(t);
range.select();
}
},
colour: {
@ -156,10 +156,10 @@ module.exports = {
navigator.clipboard.writeText(c).then(function () {
showMessage("Copied ".concat(w, "."));
}, function (e) {
copyColourFallback(c, w);
copyFallback(c, w);
});
} else {
copyColourFallback(c, w);
copyFallback(c, w);
}
},
positionTooltip: function positionTooltip() {
@ -174,9 +174,25 @@ module.exports = {
});
}
},
// getCSS: (el, prop, b = false) {
// return window.getComputedStyle(el, null).getPropertyValue(prop);
// },
getCSS: function getCSS(el, prop) {
var b = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : false;
return window.getComputedStyle(el, null).getPropertyValue(prop);
},
getTabPath: function getTabPath(t) {
var url = window.location.toString();
url = url.indexOf("?") > 0 ? url.substring(0, url.indexOf("?")) : url;
url = "".concat(url, "?p=").concat(t.closest("article").getAttribute("data-path"), "#").concat(t.getAttribute("id"));
var type = "URL";
if (navigator.clipboard) {
navigator.clipboard.writeText(url).then(function () {
showMessage("Copied ".concat(type, "."));
}, function (e) {
copyFallback(url, type);
});
} else {
copyFallback(url, type);
}
},
init: function init() {
var args = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
var url = getURLVars();
@ -204,11 +220,6 @@ module.exports = {
var observer = new IntersectionObserver(function (articles) {
articles.forEach(function (article) {
var a = article.target;
// console.log("observing: ", { id: a.getAttribute("id"), intersecting: a.isIntersecting } )
// if (article.intersectionRatio > 0) {
// console.log("Is interesecting: ", { id: article.target.getAttribute("id"), intersecting: article.isIntersecting, ratio: article.intersectionRatio } )
if (article.isIntersecting == true) {
var path = a.getAttribute("data-path");
path = "patterns/" + (a.getAttribute("data-core") == "true" ? "core/" + path.substring(path.lastIndexOf("/") + 1) : a.getAttribute("data-path")) + "/index.html";
@ -242,7 +253,7 @@ module.exports = {
Prism.highlightAll();
a.querySelectorAll("code").forEach(function (c) {
c.onclick = function (e) {
oneClickSelect(e);
module.exports.oneClickSelect(e);
};
});
module.exports.colour.positionTooltip();
@ -3163,13 +3174,17 @@ function flip(e) {
module.exports = {
init: function init() {
var p = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : document;
p.querySelectorAll("[role='switch']").forEach(function (sw) {
sw.innerHTML = "<span></span>";
sw.setAttribute("aria-checked", "false");
sw.setAttribute("tabindex", "0");
sw.addEventListener("click", flip, false);
sw.addEventListener("keypress", flip, false);
});
try {
p.querySelectorAll("[role='switch']").forEach(function (sw) {
sw.innerHTML = "<span></span>";
sw.setAttribute("aria-checked", "false");
sw.setAttribute("tabindex", "0");
sw.addEventListener("click", flip, false);
sw.addEventListener("keypress", flip, false);
});
} catch (e) {
console.warn("Cannot initialise switches.", e);
}
}
};
@ -3192,10 +3207,30 @@ var click = new MouseEvent('click', {
bubbles: false,
cancelable: true
});
var waitForElement = function waitForElement(selector) {
return new Promise(function (resolve) {
if (document.querySelector(selector)) {
return resolve(document.querySelector(selector));
}
var observer = new MutationObserver(function (mutations) {
if (document.querySelector(selector)) {
observer.disconnect();
resolve(document.querySelector(selector));
}
});
// If you get "parameter 1 is not of type 'Node'" error, see https://stackoverflow.com/a/77855838/492336
observer.observe(document.body, {
childList: true,
subtree: true
});
});
};
function init() {
var p = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : document;
var s = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : true;
p.querySelectorAll(".tab-group, tabset").forEach(function (tabGroup) {
var container = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : document;
var spacer = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : true;
var args = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
container.querySelectorAll(".tab-group, tabset").forEach(function (tabGroup) {
if (tabGroup.querySelector("[role=tablist]") === null) {
var tabgroup = tabGroup.getAttribute("id");
var tablist = "";
@ -3218,23 +3253,31 @@ function init() {
});
var ul = document.createElement('ul');
ul.setAttribute("role", "tablist");
ul.innerHTML = s != true ? "".concat(tablist) : "".concat(tablist, "<li role=\"separator\" class=\"separator\"></li>");
ul.innerHTML = spacer != true ? "".concat(tablist) : "".concat(tablist, "<li role=\"separator\" class=\"separator\"></li>");
tabGroup.insertBefore(ul, tabGroup.firstChild);
tabGroup.querySelectorAll('[role="tab"]').forEach(function (tab) {
tab.addEventListener("click", function () {
var siblings = Array.from(tab.parentNode.children);
siblings.forEach(function (sibling) {
return sibling.classList.remove("selected");
});
tab.classList.add("selected");
var tabPanels = Array.from(tab.parentNode.parentNode.children).filter(function (child) {
return child.getAttribute("role") === "tabpanel";
});
tabPanels.forEach(function (panel) {
return panel.classList.remove("open");
});
var tabPanelId = tab.getAttribute("id").replace("tab", "tab-panel");
document.getElementById(tabPanelId).classList.add("open");
tab.addEventListener("click", function (e) {
if (e.altKey && typeof args.altModifier == "function") {
args.altModifier(tab);
} else if (e.shiftKey && typeof args.shiftModifier == "function") {
args.shiftModifier(tab);
} else if (e.metaKey && typeof args.metaModifier == "function") {
args.metaModifier(tab);
} else {
var siblings = Array.from(tab.parentNode.children);
siblings.forEach(function (sibling) {
return sibling.classList.remove("selected");
});
tab.classList.add("selected");
var tabPanels = Array.from(tab.parentNode.parentNode.children).filter(function (child) {
return child.getAttribute("role") === "tabpanel";
});
tabPanels.forEach(function (panel) {
return panel.classList.remove("open");
});
var tabPanelId = tab.getAttribute("id").replace("tab", "tab-panel");
document.getElementById(tabPanelId).classList.add("open");
}
});
tab.addEventListener("keypress", function (e) {
e.preventDefault();
@ -3244,6 +3287,12 @@ function init() {
});
});
}
if (document.location.hash != "" && document.location.hash.substring(0, 5) == "#tab-") {
waitForElement(document.location.hash).then(function (el) {
el.scrollIntoView();
el.dispatchEvent(click);
});
}
});
}
@ -3365,10 +3414,12 @@ __webpack_require__.r(__webpack_exports__);
// init core
// init c
_core_core_js__WEBPACK_IMPORTED_MODULE_0__.init({
success: function success(a) {
_pg_patterns_core_tabs_tabs_js__WEBPACK_IMPORTED_MODULE_9__.init(a);
_pg_patterns_core_tabs_tabs_js__WEBPACK_IMPORTED_MODULE_9__.init(a, true, {
shiftModifier: _core_core_js__WEBPACK_IMPORTED_MODULE_0__.getTabPath
});
_pg_patterns_core_switch_switch_js__WEBPACK_IMPORTED_MODULE_8__.init(a);
_pg_patterns_core_sticky_note_sticky_note_js__WEBPACK_IMPORTED_MODULE_7__.init(a);
},
@ -3388,7 +3439,6 @@ var flipInfoSwitch = function flipInfoSwitch(e) {
});
break;
case "breakpoints":
console.log("here");
_core_core_js__WEBPACK_IMPORTED_MODULE_0__.cookie.set("show-breakpoints", s.getAttribute("aria-checked"), 30, "/");
document.querySelector("html").classList[s.getAttribute("aria-checked") == "true" ? "add" : "remove"]("show-breakpoints");
break;

File diff suppressed because one or more lines are too long

View File

@ -287,23 +287,23 @@
<div class="tab-group" id="colors">
<div data-tab="css">
<pre class="language-css">:root {
--colour-blue: #2e51a1,
--colour-blue-l: #5c7abf,
--colour-blue-xl: #b2c3ec,
--colour-blue-d: #133176,
--colour-blue-xd: #031235,
--colour-blue: #2e51a1;
--colour-blue-l: #5c7abf;
--colour-blue-xl: #b2c3ec;
--colour-blue-d: #133176;
--colour-blue-xd: #031235;
--colour-grey: #7f7f7f,
--colour-grey-l: #b2b2b2,
--colour-grey-xl: #d8d8d8,
--colour-grey-xxl: #f0f0f0,
--colour-white: #fff,
--colour-page: #fff,
--colour-light: #fff,
--colour-grey-d: #4c4c4c,
--colour-grey-xd: #4c4c4c,
--colour-black: #000,
--colour-dark: #000,
--colour-grey: #7f7f7f;
--colour-grey-l: #b2b2b2;
--colour-grey-xl: #d8d8d8;
--colour-grey-xxl: #f0f0f0;
--colour-white: #fff;
--colour-page: #fff;
--colour-light: #fff;
--colour-grey-d: #4c4c4c;
--colour-grey-xd: #4c4c4c;
--colour-black: #000;
--colour-dark: #000;
}</pre>
</div>
<div data-tab="scss">

View File

@ -82,13 +82,17 @@ function flip(e) {
module.exports = {
init: (p = document) => {
p.querySelectorAll("[role='switch']").forEach((sw) => {
sw.innerHTML = "<span></span>";
sw.setAttribute("aria-checked", "false");
sw.setAttribute("tabindex", "0");
sw.addEventListener("click", flip, false);
sw.addEventListener("keypress", flip, false);
})
try {
p.querySelectorAll("[role='switch']").forEach((sw) => {
sw.innerHTML = "<span></span>";
sw.setAttribute("aria-checked", "false");
sw.setAttribute("tabindex", "0");
sw.addEventListener("click", flip, false);
sw.addEventListener("keypress", flip, false);
})
} catch (e) {
console.warn("Cannot initialise switches.", e);
}
}
}
</pre>

View File

@ -2,6 +2,13 @@
<html>
<head>
<title>Pattern</title>
<script>
let u = document.location.href.substring(0, document.location.href.search(/patterns/i));
let p = document.location.pathname.substring(document.location.pathname.search(/patterns/i));
p = p.replace(/\/$|\/index\.html/i, "").substring(9);
window.location = u + "?p=" + p;
</script>
</head>
<body data-prismjs-copy-timeout="1500">
<h2>What is it</h2>
@ -17,6 +24,14 @@
<p>Users should not need to see content of multiple tabs simultaneously and the user should be able to easily recognise where they are within the content. </p>
<h2>How to use it</h2>
<p>The structure of the tab set is defined in html. There are two forms supported. Adding a class of <code class="inline">.tab-group</code> to the container element will work in place of the <code class="inline">tabset</code> tag, and the tab panels can be defined using either <code class="inline">tab=""</code> or <code class="inline">data-tab=""</code>. Passing an optional element to the init function will initialise tabs within that element. </p>
<p>The tab initalize function now takes a new function parameter in the form of an third argument is an object that can take the following callbacks: </p>
<ul>
<li>altModifer (When the altKey is used)</li>
<li>shiftModifier (When the shift key is used)</li>
<li>metaModifier (When the Windows key or Apple key is used)</li>
</ul>
<p>You can use these callbacks to create a custom event to get the tab information. </p>
<p>Note: There is a new core function (core.getTabPath) that will generate the query string and url hash for use in DS2 Core. You may wish to update your scaffolding.js file to make use of this functionality. </p>
<tabset id="tabs">
<pre class="language-html" tab="html">
<tabset id="uniqueID">
@ -169,8 +184,31 @@ const click = new MouseEvent('click', {
cancelable: true
});
export function init(p = document, s = true) {
p.querySelectorAll(".tab-group, tabset").forEach(tabGroup => {
const waitForElement = (selector) => {
return new Promise(resolve => {
if (document.querySelector(selector)) {
return resolve(document.querySelector(selector));
}
const observer = new MutationObserver(mutations => {
if (document.querySelector(selector)) {
observer.disconnect();
resolve(document.querySelector(selector));
}
});
// If you get "parameter 1 is not of type 'Node'" error, see https://stackoverflow.com/a/77855838/492336
observer.observe(document.body, {
childList: true,
subtree: true
});
});
}
export function init(container = document, spacer = true, args = {}) {
container.querySelectorAll(".tab-group, tabset").forEach(tabGroup => {
if (tabGroup.querySelector("[role=tablist]") === null) {
const tabgroup = tabGroup.getAttribute("id");
@ -196,21 +234,29 @@ export function init(p = document, s = true) {
const ul = document.createElement('ul');
ul.setAttribute("role", "tablist");
ul.innerHTML = s != true ? `${tablist}` : `${tablist}<li role="separator" class="separator"></li>`;
ul.innerHTML = spacer != true ? `${tablist}` : `${tablist}<li role="separator" class="separator"></li>`;
tabGroup.insertBefore(ul, tabGroup.firstChild);
tabGroup.querySelectorAll('[role="tab"]').forEach(tab => {
tab.addEventListener("click", () => {
const siblings = Array.from(tab.parentNode.children);
siblings.forEach(sibling => sibling.classList.remove("selected"));
tab.classList.add("selected");
tab.addEventListener("click", (e) => {
if (e.altKey && typeof args.altModifier == "function") {
args.altModifier(tab);
} else if (e.shiftKey && typeof args.shiftModifier == "function") {
args.shiftModifier(tab);
} else if (e.metaKey && typeof args.metaModifier == "function") {
args.metaModifier(tab);
} else {
const siblings = Array.from(tab.parentNode.children);
siblings.forEach(sibling => sibling.classList.remove("selected"));
tab.classList.add("selected");
const tabPanels = Array.from(tab.parentNode.parentNode.children)
.filter(child => child.getAttribute("role") === "tabpanel");
tabPanels.forEach(panel => panel.classList.remove("open"));
const tabPanels = Array.from(tab.parentNode.parentNode.children)
.filter(child => child.getAttribute("role") === "tabpanel");
tabPanels.forEach(panel => panel.classList.remove("open"));
const tabPanelId = tab.getAttribute("id").replace("tab", "tab-panel");
document.getElementById(tabPanelId).classList.add("open");
const tabPanelId = tab.getAttribute("id").replace("tab", "tab-panel");
document.getElementById(tabPanelId).classList.add("open");
}
});
@ -222,6 +268,14 @@ export function init(p = document, s = true) {
})
});
}
if (document.location.hash != "" && document.location.hash.substring(0,5) == "#tab-") {
waitForElement(document.location.hash).then((el) => {
el.scrollIntoView();
el.dispatchEvent(click);
});
}
});
}
</pre>

View File

@ -21,7 +21,7 @@ const font = {
size: 0
}
const copyColourFallback = (copyInfo, attr) => {
const copyFallback = (copyInfo, attr) => {
console.log("fallback")
var textArea = document.createElement('textarea');
textArea.value = copyInfo;
@ -71,22 +71,6 @@ const showMessage = (m, s) => {
}, 1000);
}
const oneClickSelect = (e, t = e.currentTarget) => {
// In here, "this" is the element
var range, selection;
if (window.getSelection) {
selection = window.getSelection();
range = document.createRange();
range.selectNodeContents(t);
selection.removeAllRanges();
selection.addRange(range);
} else if (document.body.createTextRange) {
range = document.body.createTextRange();
range.moveToElementText(t);
range.select();
}
}
const getURLVars = () => {
var oResult = {};
if (location.search.length > 0) {
@ -145,12 +129,26 @@ module.exports = {
}
return "";
},
remove: (cnane) => {
setCookie(cname, "", -1);
remove: (cname) => {
module.exports.cookie.set(cname, null, new Date(null));
},
},
oneClickSelect: (e, t = e.currentTarget) => {
// In here, "this" is the element
var range, selection;
if (window.getSelection) {
selection = window.getSelection();
range = document.createRange();
range.selectNodeContents(t);
selection.removeAllRanges();
selection.addRange(range);
} else if (document.body.createTextRange) {
range = document.body.createTextRange();
range.moveToElementText(t);
range.select();
}
},
colour: {
copy: (w, t) => {
let c = t.parentNode.getAttribute("data-" + (w=="var" ? "token" : w));
c = w == "var" ? `var(${c})` : c;
@ -159,10 +157,10 @@ module.exports = {
navigator.clipboard.writeText(c).then(function() {
showMessage(`Copied ${w}.`);
}, function(e) {
copyColourFallback(c,w);
copyFallback(c,w);
});
} else {
copyColourFallback(c, w);
copyFallback(c, w);
}
},
@ -178,9 +176,26 @@ module.exports = {
})
}
},
// getCSS: (el, prop, b = false) {
// return window.getComputedStyle(el, null).getPropertyValue(prop);
// },
getCSS: (el, prop, b = false) => {
return window.getComputedStyle(el, null).getPropertyValue(prop);
},
getTabPath: (t) => {
let url = window.location.toString();
url = url.indexOf("?") > 0 ? url.substring(0,url.indexOf("?")) : url;
url = `${url}?p=${t.closest("article").getAttribute("data-path")}#${t.getAttribute("id")}`
let type = "URL";
if (navigator.clipboard) {
navigator.clipboard.writeText(url).then(function() {
showMessage(`Copied ${type}.`);
}, function(e) {
copyFallback(url,type);
});
} else {
copyFallback(url, type);
}
},
init: (args = {}) => {
const url = getURLVars();
font.size = parseFloat(getComputedStyle(document.documentElement).fontSize.replace("px",""));
@ -211,10 +226,6 @@ module.exports = {
articles.forEach(article => {
let a = article.target;
// console.log("observing: ", { id: a.getAttribute("id"), intersecting: a.isIntersecting } )
// if (article.intersectionRatio > 0) {
// console.log("Is interesecting: ", { id: article.target.getAttribute("id"), intersecting: article.isIntersecting, ratio: article.intersectionRatio } )
if (article.isIntersecting == true) {
let path = a.getAttribute("data-path");
path = "patterns/" +
@ -255,7 +266,7 @@ module.exports = {
a.querySelectorAll("code").forEach((c)=> {
c.onclick = (e) => {
oneClickSelect(e);
module.exports.oneClickSelect(e);
}
})

View File

@ -12,10 +12,12 @@ import * as stickynote from "../pg/patterns/core/sticky-note/_sticky-note.js";
import * as swtch from "../pg/patterns/core/switch/_switch.js";
import * as tabs from "../pg/patterns/core/tabs/_tabs.js";
// init core
// init c
core.init({
success: (a) => {
tabs.init(a);
tabs.init(a, true, {
shiftModifier: core.getTabPath,
});
swtch.init(a);
stickynote.init(a);
},
@ -24,6 +26,7 @@ core.init({
}
});
// deprecated switch handler
const flipInfoSwitch = (e, s = e.currentTarget) => {
@ -37,12 +40,10 @@ const flipInfoSwitch = (e, s = e.currentTarget) => {
break;
case "breakpoints" :
console.log("here")
core.cookie.set("show-breakpoints", s.getAttribute("aria-checked"), 30, "/");
document.querySelector("html").classList[( s.getAttribute("aria-checked") == "true" ? "add" : "remove" )]("show-breakpoints");
break;
}
}
// create a pure JS mouse click event

View File

@ -128,15 +128,15 @@
- function generateCSS(c, p) {
- let o = "";
- for (let i = 0; i < c.length; i++) {
- o += `\n\t--${p}-${c[i].name.toLowerCase()}: ${ color(c[i].color, "hex").toLowerCase() },\n`;
- o += `\n\t--${p}-${c[i].name.toLowerCase()}: ${ color(c[i].color, "hex").toLowerCase() };\n`;
- for (let ii = 0; ii < c[i].grad.l.length; ii++) {
- o += `\t--${p}-${c[i].grad.l[ii].n.toLowerCase()}: ${ color(c[i].grad.l[ii].c, "hex").toLowerCase() },\n`;
- o += `\t--${p}-${c[i].grad.l[ii].n.toLowerCase()}: ${ color(c[i].grad.l[ii].c, "hex").toLowerCase() };\n`;
- }
- for (let ii = 0; ii < c[i].grad.d.length; ii++) {
- o += `\t--${p}-${c[i].grad.d[ii].n.toLowerCase()}: ${ color(c[i].grad.d[ii].c, "hex").toLowerCase() },\n`;
- o += `\t--${p}-${c[i].grad.d[ii].n.toLowerCase()}: ${ color(c[i].grad.d[ii].c, "hex").toLowerCase() };\n`;
- }
- }
- return o;
- return o;
- }
if !colortxt

View File

@ -37,6 +37,11 @@ html
head
title Pattern
script.
let u = document.location.href.substring(0, document.location.href.search(/patterns/i));
let p = document.location.pathname.substring(document.location.pathname.search(/patterns/i));
p = p.replace(/\/$|\/index\.html/i, "").substring(9);
window.location = u + "?p=" + p;
body(data-assetpath= assetpath data-prismjs-copy-timeout="1500")

View File

@ -75,7 +75,7 @@ include _colour-samples
"lighter lighter lighter darker darker darker"
"notes notes notes notes notes notes";
grid-template-columns: repeat(6, 1fr);
grid-template-rows: repeat(2, 1.5rem) 10rem repeat(3, max-content); // 3rem repeat(2, 2rem) 1.5rem repeat(3, max-content);
grid-template-rows: repeat(2, 1.5rem) repeat(4, max-content); // 3rem repeat(2, 2rem) 1.5rem repeat(3, max-content);
padding: 1rem;
width: 20rem;
max-width: 318px;
@ -115,7 +115,7 @@ include _colour-samples
display: grid;
gap: .5rem;
grid-template-columns: repeat(3, 1fr);
grid-template-rows: 2.5rem repeat(2, max-content);
grid-template-rows: repeat(3, max-content);
.result {
align-items: center;
border-radius: .5rem;
@ -188,7 +188,7 @@ include _colour-samples
padding: .5rem;
width: 20rem;
max-width: 318px;
height: 10.5rem;
height: max-contents;
display: grid;
gap: .5rem;
@ -231,6 +231,7 @@ include _colour-samples
display: block;
width: 100%;
place-self: stretch;
text-align: center;
span {
border: none;
font-size: .9rem;

View File

@ -15,12 +15,16 @@ function flip(e) {
module.exports = {
init: (p = document) => {
p.querySelectorAll("[role='switch']").forEach((sw) => {
sw.innerHTML = "<span></span>";
sw.setAttribute("aria-checked", "false");
sw.setAttribute("tabindex", "0");
sw.addEventListener("click", flip, false);
sw.addEventListener("keypress", flip, false);
})
try {
p.querySelectorAll("[role='switch']").forEach((sw) => {
sw.innerHTML = "<span></span>";
sw.setAttribute("aria-checked", "false");
sw.setAttribute("tabindex", "0");
sw.addEventListener("click", flip, false);
sw.addEventListener("keypress", flip, false);
})
} catch (e) {
console.warn("Cannot initialise switches.", e);
}
}
}

View File

@ -9,8 +9,31 @@ const click = new MouseEvent('click', {
cancelable: true
});
export function init(p = document, s = true) {
p.querySelectorAll(".tab-group, tabset").forEach(tabGroup => {
const waitForElement = (selector) => {
return new Promise(resolve => {
if (document.querySelector(selector)) {
return resolve(document.querySelector(selector));
}
const observer = new MutationObserver(mutations => {
if (document.querySelector(selector)) {
observer.disconnect();
resolve(document.querySelector(selector));
}
});
// If you get "parameter 1 is not of type 'Node'" error, see https://stackoverflow.com/a/77855838/492336
observer.observe(document.body, {
childList: true,
subtree: true
});
});
}
export function init(container = document, spacer = true, args = {}) {
container.querySelectorAll(".tab-group, tabset").forEach(tabGroup => {
if (tabGroup.querySelector("[role=tablist]") === null) {
const tabgroup = tabGroup.getAttribute("id");
@ -36,21 +59,29 @@ export function init(p = document, s = true) {
const ul = document.createElement('ul');
ul.setAttribute("role", "tablist");
ul.innerHTML = s != true ? `${tablist}` : `${tablist}<li role="separator" class="separator"></li>`;
ul.innerHTML = spacer != true ? `${tablist}` : `${tablist}<li role="separator" class="separator"></li>`;
tabGroup.insertBefore(ul, tabGroup.firstChild);
tabGroup.querySelectorAll('[role="tab"]').forEach(tab => {
tab.addEventListener("click", () => {
const siblings = Array.from(tab.parentNode.children);
siblings.forEach(sibling => sibling.classList.remove("selected"));
tab.classList.add("selected");
tab.addEventListener("click", (e) => {
if (e.altKey && typeof args.altModifier == "function") {
args.altModifier(tab);
} else if (e.shiftKey && typeof args.shiftModifier == "function") {
args.shiftModifier(tab);
} else if (e.metaKey && typeof args.metaModifier == "function") {
args.metaModifier(tab);
} else {
const siblings = Array.from(tab.parentNode.children);
siblings.forEach(sibling => sibling.classList.remove("selected"));
tab.classList.add("selected");
const tabPanels = Array.from(tab.parentNode.parentNode.children)
.filter(child => child.getAttribute("role") === "tabpanel");
tabPanels.forEach(panel => panel.classList.remove("open"));
const tabPanels = Array.from(tab.parentNode.parentNode.children)
.filter(child => child.getAttribute("role") === "tabpanel");
tabPanels.forEach(panel => panel.classList.remove("open"));
const tabPanelId = tab.getAttribute("id").replace("tab", "tab-panel");
document.getElementById(tabPanelId).classList.add("open");
const tabPanelId = tab.getAttribute("id").replace("tab", "tab-panel");
document.getElementById(tabPanelId).classList.add("open");
}
});
@ -62,5 +93,13 @@ export function init(p = document, s = true) {
})
});
}
if (document.location.hash != "" && document.location.hash.substring(0,5) == "#tab-") {
waitForElement(document.location.hash).then((el) => {
el.scrollIntoView();
el.dispatchEvent(click);
});
}
});
}

View File

@ -22,6 +22,15 @@ block content
+h(2)
p The structure of the tab set is defined in html. There are two forms supported. Adding a class of #[code.inline .tab-group] to the container element will work in place of the #[code.inline tabset] tag, and the tab panels can be defined using either #[code.inline tab=""] or #[code.inline data-tab=""]. Passing an optional element to the init function will initialise tabs within that element.
p The tab initalize function now takes a new function parameter in the form of an third argument is an object that can take the following callbacks:
ul
li altModifer (When the altKey is used)
li shiftModifier (When the shift key is used)
li metaModifier (When the Windows key or Apple key is used)
p You can use these callbacks to create a custom event to get the tab information.
p Note: There is a new core function (core.getTabPath) that will generate the query string and url hash for use in DS2 Core. You may wish to update your scaffolding.js file to make use of this functionality.
tabset#tabs
pre.language-html(tab="html")

View File

@ -74,7 +74,7 @@
"lighter lighter lighter darker darker darker"
"notes notes notes notes notes notes";
grid-template-columns: repeat(6, 1fr);
grid-template-rows: repeat(2, 1.5rem) 10rem repeat(3, max-content); // 3rem repeat(2, 2rem) 1.5rem repeat(3, max-content);
grid-template-rows: repeat(2, 1.5rem) repeat(4, max-content); // 3rem repeat(2, 2rem) 1.5rem repeat(3, max-content);
padding: 1rem;
width: 20rem;
max-width: 318px;
@ -114,7 +114,7 @@
display: grid;
gap: .5rem;
grid-template-columns: repeat(3, 1fr);
grid-template-rows: 2.5rem repeat(2, max-content);
grid-template-rows: repeat(3, max-content);
.result {
align-items: center;
border-radius: .5rem;
@ -187,7 +187,7 @@
padding: .5rem;
width: 20rem;
max-width: 318px;
height: 10.5rem;
height: max-contents;
display: grid;
gap: .5rem;
@ -230,6 +230,7 @@
display: block;
width: 100%;
place-self: stretch;
text-align: center;
span {
border: none;
font-size: .9rem;