gamv/ds2-core
1
0
Fork 0
Code Issues 8 Releases 7 Activity

Compare commits

base: gamv:main
Branches Tags
gamv:main
gamv:v1.1
gamv:v1.02
gamv:v1.02-pre-release
gamv:v1.01
gamv:v1.0
gamv:v0.9
gamv:v0.81
gamv:v0.8
gamv:v0.7
..
compare: gamv:v0.81
Branches Tags
gamv:main
gamv:v1.1
gamv:v1.02
gamv:v1.02-pre-release
gamv:v1.01
gamv:v1.0
gamv:v0.9
gamv:v0.81
gamv:v0.8
gamv:v0.7

No commits in common. "main" and "v0.81" have entirely different histories.
main ... v0.81

50 changed files with 1446 additions and 1664 deletions
Show Stats Expand all files Collapse all files

85
Readme.md
View File

@ -1,14 +1,4 @@
# 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" ## "Installation"
@ -21,23 +11,20 @@ src/pg/core/download.php.pug | public
All other pug files should compile to from src/pg/ to a relative path of public/* All other pug files should compile to from src/pg/ to a relative path of public/*
## Running the core ## Running the core
### Callback functions functions
Callback functions can be used in
- beforeArticleLoad - called before any patterns have started to load beforeArticleLoad - called before any patterns are started to load
- success - called when loading a pattern is successful if the result is an HTTP 200 success - called when loading a pattern is successful if the result is an HTTP 200
- afterArticleLoad - called after any patterns have started to load 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. 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.
## Creating an item ## About the content variable
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 - name - the hypenated name of the pattern
- status - this should be one of the statuses from your status array - 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 - display - (optional) if present this will be displayed, as is, instead of the name
@ -47,57 +34,3 @@ The content variable in \/src\/pg\/_config.pug defines your array of patterns. I
By changing and resaving the \_config.pug file, (our change is often adding or removing a random space) all of the pug patterns will recompile. Note that md templates will not recompile automatically when config is saved and updated as markdown files don't have an include. By changing and resaving the \_config.pug file, (our change is often adding or removing a random space) all of the pug patterns will recompile. Note that md templates will not recompile automatically when config is saved and updated as markdown files don't have an include.
## Including PugJS in Pug files without compiling
If you wish to include Pug output as code in your instance, you can do this without manually creating a second 'dot container' version of the file. Including files with 'unrecognised' extensions does not compile them.
1. In your project config, create a Custom Tool called Pug pattern to pug file
1. Check Process automatically and set the command to 'cp {{input}} {{output}}' on Mac/Linux and 'copy {{input}} {{output}}' on Windows. (This is just your operating system's command line file copy executable.)
1. Set the Output to Relative to input
1. Set the Output Extension to .pug
In your design system implementation,
1. Create the files that you edit as _[pattern].pp files, and set them to auto compile. (You may wish to let your text editor know what they are, so the syntax highlighting works.
1. Save the file, ensure that it is set to in prepros it is set to process automatically.
1. Include the .pp file as your pug pattern with .language-pug and include the .pug file as your html output.
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)>

6
ds2 core.sublime-project
View File

@ -2,11 +2,7 @@
"folders": "folders":
[ [
{ {
"path": ".", "path": "."
"folder_exclude_patterns": ["src/pg/patterns"]
}, },
{
"path": "./src/pg/patterns"
}
], ],
} }

26
ds2 core.sublime-workspace
View File

@ -281,14 +281,17 @@
"expanded_folders": "expanded_folders":
[ [
"/Users/am/Desktop/ds2-core", "/Users/am/Desktop/ds2-core",
"/Users/am/Desktop/ds2-core/src/pg/patterns" "/Users/am/Desktop/ds2-core/src",
"/Users/am/Desktop/ds2-core/src/pg",
"/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/core/components",
"/Users/am/Desktop/ds2-core/src/pg/patterns/core/components/sticky-note",
"/Users/am/Desktop/ds2-core/src/pg/patterns/core/components/switch",
"/Users/am/Desktop/ds2-core/src/pg/patterns/core/components/tooltip"
], ],
"file_history": "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/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/components/sticky-note/index.pug",
"/Users/am/Desktop/ds2-core/src/pg/patterns/core/layouts/breakpoints/index.pug", "/Users/am/Desktop/ds2-core/src/pg/patterns/core/layouts/breakpoints/index.pug",
@ -412,11 +415,15 @@
"/Users/am/Desktop/my DS2/src/pg/patterns/components/tooltip/index.pug", "/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/link/index.pug",
"/Users/am/Desktop/my DS2/src/pg/patterns/components/progress-bar/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/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/visual-design/colours/index.pug"
], ],
"find": "find":
{ {
"height": 24.0 "height": 26.0
}, },
"find_in_files": "find_in_files":
{ {
@ -431,7 +438,6 @@
"case_sensitive": false, "case_sensitive": false,
"find_history": "find_history":
[ [
"oneClickSelect",
"../core/_master-pattern.pug", "../core/_master-pattern.pug",
"../core", "../core",
"hide-deprecated", "hide-deprecated",
@ -505,7 +511,7 @@
], ],
"incremental_find": "incremental_find":
{ {
"height": 24.0 "height": 26.0
}, },
"input": "input":
{ {
@ -550,7 +556,7 @@
"project": "ds2 core.sublime-project", "project": "ds2 core.sublime-project",
"replace": "replace":
{ {
"height": 44.0 "height": 68.0
}, },
"save_all_on_build": false, "save_all_on_build": false,
"select_file": "select_file":

50
prepros.config
View File

@ -492,9 +492,6 @@
"resolveJsonModule": false, "resolveJsonModule": false,
"esModuleInterop": false, "esModuleInterop": false,
"useDefineForClassFields": false "useDefineForClassFields": false
},
"custom-gzg6caunrh": {
"command": "cp {{input}} {{output}}"
} }
}, },
"fileTypes": { "fileTypes": {
@ -958,26 +955,6 @@
"type": "SOURCE_RELATIVE", "type": "SOURCE_RELATIVE",
"relativePath": "" "relativePath": ""
} }
},
"custom-sm9kzo2npr": {
"autoCompile": true,
"label": "Pug pattern to pug file",
"extensions": [
".pp"
],
"tasks": [
{
"task": "custom-gzg6caunrh",
"enable": true
}
],
"output": {
"extension": ".pug",
"type": "SOURCE_RELATIVE",
"relativePath": "",
"suffix": "-dist",
"alwaysSuffix": false
}
} }
}, },
"files": [ "files": [
@ -1207,9 +1184,6 @@
"concat-js": { "concat-js": {
"enable": false "enable": false
}, },
"babel": {
"enable": true
},
"bundle-js": { "bundle-js": {
"enable": true, "enable": true,
"options": { "options": {
@ -1372,30 +1346,6 @@
} }
} }
}, },
{
"file": "src/pg/patterns/core/sticky-note/_sticky-note.pp",
"config": {
"autoCompile": true
}
},
{
"file": "src/pg/patterns/core/switch/_switch.pp",
"config": {
"autoCompile": true
}
},
{
"file": "src/pg/patterns/core/tabs/_tabs.pp",
"config": {
"autoCompile": true
}
},
{
"file": "src/pg/patterns/core/tooltip/_tooltip.pp",
"config": {
"autoCompile": true
}
},
{ {
"file": "src/pg/patterns/layouts/header-core/header.scss", "file": "src/pg/patterns/layouts/header-core/header.scss",
"config": { "config": {

1067
public/assets/scaffolding-min.js vendored
View File

File diff suppressed because it is too large Load Diff

2
public/assets/scaffolding.css
View File

File diff suppressed because one or more lines are too long

47
public/index.html
View File

@ -38,53 +38,52 @@
<li><a href="./?p=status">Status</a></li> <li><a href="./?p=status">Status</a></li>
</ul> </ul>
</nav> </nav>
<p class="info-switches"><span></span><span id="deprecated" role="switch"></span> <p class="deprecated-switch"><span></span><span id="deprecated" role="switch"></span>
<label for="deprecated">Show deprecated patterns</label><span></span><span id="breakpoints" role="switch"></span> <label for="deprecated">Show deprecated patterns</label>
<label for="breakpoints">Show breakpoint information</label>
</p> </p>
<main id="main"> <main id="main">
<h1>DS2 core</h1> <h1>DS2 core</h1>
<article id="this-pattern-doesnt-exist" data-name="this pattern doesn't exist" data-status="deprecated" data-template="pug" data-core="false" data-path="this-pattern-doesnt-exist" style="height: 100vh"> <article id="this-pattern-doesnt-exist" data-name="this pattern doesn't exist" data-status="deprecated" data-template="pug" data-core="false" data-path="this-pattern-doesnt-exist">
<h1 class="status-deprecated"><span>This pattern doesn't exist <h1 class="status-deprecated"><span>This pattern doesn't exist
<tool-tip role="tooltip" inert="inert" tip-position="right">Deprecated</tool-tip></span></h1> <tool-tip role="tooltip" inert="inert" tip-position="right">Deprecated</tool-tip></span></h1>
</article> </article>
<article id="colours" data-name="colours" data-status="complete" data-template="pug" data-core="true" data-path="colours" style="height: 100vh"> <article id="colours" data-name="colours" data-status="complete" data-template="pug" data-core="true" data-path="colours">
<h1 class="status-complete"><span>Colours <h1 class="status-complete"><span>Colours
<tool-tip role="tooltip" inert="inert" tip-position="right">Complete</tool-tip></span></h1> <tool-tip role="tooltip" inert="inert" tip-position="right">Complete</tool-tip></span></h1>
</article> </article>
<article id="components" data-name="components" data-status="complete" data-template="none" data-core="false" data-path="components" style="height: 100vh"> <article id="components" data-name="components" data-status="complete" data-template="none" data-core="false" data-path="components">
<h1 class="status-complete"><span>Components <h1 class="status-complete"><span>Components
<tool-tip role="tooltip" inert="inert" tip-position="right">Complete</tool-tip></span></h1> <tool-tip role="tooltip" inert="inert" tip-position="right">Complete</tool-tip></span></h1>
</article> </article>
<article id="components-sticky-note" data-name="sticky-note" data-status="complete" data-template="pug" data-core="true" data-path="components/sticky-note" style="height: 100vh"> <article id="components-sticky-note" data-name="sticky-note" data-status="complete" data-template="pug" data-core="true" data-path="components/sticky-note">
<h1 class="status-complete"><span>Sticky note <h1 class="status-complete"><span>Sticky note
<tool-tip role="tooltip" inert="inert" tip-position="right">Complete</tool-tip></span></h1> <tool-tip role="tooltip" inert="inert" tip-position="right">Complete</tool-tip></span></h1>
</article> </article>
<article id="components-switch" data-name="switch" data-status="complete" data-template="pug" data-core="true" data-path="components/switch" style="height: 100vh"> <article id="components-switch" data-name="switch" data-status="in-progress" data-template="pug" data-core="true" data-path="components/switch">
<h1 class="status-complete"><span>Switch <h1 class="status-in-progress"><span>Switch
<tool-tip role="tooltip" inert="inert" tip-position="right">Complete</tool-tip></span></h1> <tool-tip role="tooltip" inert="inert" tip-position="right">In progress</tool-tip></span></h1>
</article> </article>
<article id="components-tooltip" data-name="tooltip" data-status="complete" data-template="pug" data-core="true" data-path="components/tooltip" style="height: 100vh"> <article id="components-tooltip" data-name="tooltip" data-status="in-progress" data-template="pug" data-core="true" data-path="components/tooltip">
<h1 class="status-complete"><span>Tooltip <h1 class="status-in-progress"><span>Tooltip
<tool-tip role="tooltip" inert="inert" tip-position="right">Complete</tool-tip></span></h1> <tool-tip role="tooltip" inert="inert" tip-position="right">In progress</tool-tip></span></h1>
</article> </article>
<article id="layouts" data-name="layouts" data-status="complete" data-template="none" data-core="true" data-path="layouts" style="height: 100vh"> <article id="layouts" data-name="layouts" data-status="complete" data-template="none" data-core="true" data-path="layouts">
<h1 class="status-complete"><span>Layouts <h1 class="status-complete"><span>Layouts
<tool-tip role="tooltip" inert="inert" tip-position="right">Complete</tool-tip></span></h1> <tool-tip role="tooltip" inert="inert" tip-position="right">Complete</tool-tip></span></h1>
</article> </article>
<article id="layouts-header" data-name="header" data-status="complete" data-template="pug" data-core="true" data-path="layouts/header" style="height: 100vh"> <article id="layouts-header" data-name="header" data-status="in-progress" data-template="pug" data-core="true" data-path="layouts/header">
<h1 class="status-complete"><span>Header <h1 class="status-in-progress"><span>Header
<tool-tip role="tooltip" inert="inert" tip-position="right">Complete</tool-tip></span></h1> <tool-tip role="tooltip" inert="inert" tip-position="right">In progress</tool-tip></span></h1>
</article> </article>
<article id="layouts-breakpoints" data-name="breakpoints" data-status="complete" data-template="pug" data-core="true" data-path="layouts/breakpoints" style="height: 100vh"> <article id="layouts-breakpoints" data-name="breakpoints" data-status="in-progress" data-template="pug" data-core="true" data-path="layouts/breakpoints">
<h1 class="status-complete"><span>Breakpoints <h1 class="status-in-progress"><span>Breakpoints
<tool-tip role="tooltip" inert="inert" tip-position="right">Complete</tool-tip></span></h1> <tool-tip role="tooltip" inert="inert" tip-position="right">In progress</tool-tip></span></h1>
</article> </article>
<article id="layouts-tabs" data-name="tabs" data-status="complete" data-template="pug" data-core="true" data-path="layouts/tabs" style="height: 100vh"> <article id="layouts-tabs" data-name="tabs" data-status="in-progress" data-template="pug" data-core="true" data-path="layouts/tabs">
<h1 class="status-complete"><span>Tabs <h1 class="status-in-progress"><span>Tabs
<tool-tip role="tooltip" inert="inert" tip-position="right">Complete</tool-tip></span></h1> <tool-tip role="tooltip" inert="inert" tip-position="right">In progress</tool-tip></span></h1>
</article> </article>
<article id="status" data-name="status" data-status="complete" data-template="pug" data-core="true" data-path="status" style="height: 100vh"> <article id="status" data-name="status" data-status="complete" data-template="pug" data-core="true" data-path="status">
<h1 class="status-complete"><span>Status <h1 class="status-complete"><span>Status
<tool-tip role="tooltip" inert="inert" tip-position="right">Complete</tool-tip></span></h1> <tool-tip role="tooltip" inert="inert" tip-position="right">Complete</tool-tip></span></h1>
</article> </article>

19
public/patterns/core/breakpoints/index.html
View File

@ -5,24 +5,14 @@
</head> </head>
<body data-prismjs-copy-timeout="1500"> <body data-prismjs-copy-timeout="1500">
<h2>What is it</h2> <h2>What is it</h2>
<p>Breakpoints enable responsive mobile design.</p>
<h2>When to use it</h2> <h2>When to use it</h2>
<p>Use breakpoints when designing for different screen sizes. </p>
<p>The breakpoints SCSS mixin included implements media queries to allow for the change of the layout and design based on pre-defined screen sizes. </p>
<h2>How to use it</h2> <h2>How to use it</h2>
<p>This pattern is only available for SCSS breakpoints. The mixin is avai</p>
<p>When using this, use the default break points as they are set to the same as the Bootstrap framework. The grid for the design system at large break point has been widened to accompdate 3 colour cards across. </p> <p>When using this, use the default break points as they are set to the same as the Bootstrap framework. The grid for the design system at large break point has been widened to accompdate 3 colour cards across. </p>
<tabset id="breakpoints"> <div class="tab-group" id="breakpoints">
<div tab="scss"> <pre class="language-css" data-tab="scss">//- DS2 core (c) 2024 Alexander McIlwraith
<pre class="language-sass">@import "[path-to]/breakpoints";
@include break([breakpoint]) {
// css here
}</pre>
<pre class="language-sass">//- DS2 core (c) 2024 Alexander McIlwraith
//- Licensed under CC BY-SA 4.0 //- Licensed under CC BY-SA 4.0
// default breakpoints match bootstrap 5 breakpoints. $grid-breakpoints: ( xs: 0, sm: 576px, md: 768px, lg: 992px, xl: 1200px ) !default;
$grid-breakpoints: ( xs: 0, sm: 576px, md: 768px, lg: 992px, xl: 1200px, xxl: 1400px ) !default;
@mixin breakpoint-debug { @mixin breakpoint-debug {
body::before, body::after { body::before, body::after {
@ -105,7 +95,6 @@ $grid-breakpoints: ( xs: 0, sm: 576px, md: 768px, lg: 992px, xl: 1200px, xxl: 14
} }
} }
}</pre> }</pre>
</div> </div>
</tabset>
</body> </body>
</html> </html>

32
public/patterns/core/colours/index.html
View File

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

86
public/patterns/core/header/index.html
View File

@ -5,13 +5,10 @@
</head> </head>
<body data-prismjs-copy-timeout="1500"> <body data-prismjs-copy-timeout="1500">
<h2>What is it</h2> <h2>What is it</h2>
<p>A header is layout pattern that helps the user identify the site. </p>
<h2>When to use it</h2> <h2>When to use it</h2>
<p>Use a header at the top of every page. The 'front page' of a site may have a different header than the rest of the pages. </p>
<h2>How to use it</h2> <h2>How to use it</h2>
<p>Place the header at the top of the page after the skip to main content link. You will likely want to replace core header should be replaced with your own site's header. To do this, remove the <code class="inline language-js">core: true </code> and create your own pattern in the location you wish it in your design system. </p> <div class="tab-group" id="header">
<tabset id="header"> <pre class="language-html" data-tab="html">
<pre class="language-html" tab="html">
<!-- create temp variables and store the design system values--> <!-- create temp variables and store the design system values-->
<header> <header>
<!-- The headline banner area --> <!-- The headline banner area -->
@ -25,28 +22,7 @@
<!-- Other sections can go here, such as search and directory--> <!-- Other sections can go here, such as search and directory-->
</div> </div>
</header></pre> </header></pre>
<pre class="language-pug" tab="pug">//- DS2 core (c) 2024 Alexander McIlwraith <pre class="language-sass" data-tab="scss">//- DS2 core (c) 2024 Alexander McIlwraith
//- Licensed under CC BY-SA 4.0
//- required variables
//- site - the site name that goes in the site title
//- root - the path to the root of the site
header
// The headline banner area
svg(height='5.5rem' width='100%' xmlns='http://www.w3.org/2000/svg' aria-hidden='true')
text= site
div
div.header-title
h1
a(href="./")= site
// Other sections can go here, such as search and directory
</pre>
<pre class="language-css" tab="css">header{display:-ms-grid;display:grid;-ms-grid-rows:1.75rem 3.5rem;grid-template-rows:1.75rem 3.5rem;-ms-grid-column:2;-ms-grid-column-span:2;grid-column:2/4;overflow:hidden}header svg{grid-column:1/-1;grid-row:1/-1;-ms-grid-row-align:stretch;-ms-grid-column-align:stretch;place-self:stretch}header svg text{-webkit-transform:translate(-1rem,7.25rem);-ms-transform:translate(-1rem,7.25rem);transform:translate(-1rem,7.25rem);font-size:10rem;font-weight:1000;font-family:sans-serif;fill:var(--colour-grey-xxl)}header>div{-ms-grid-row:2;grid-row:2;grid-column:1/-1;display:-ms-grid;display:grid;grid-column-gap:1rem;-ms-grid-columns:auto -webkit-max-content -webkit-max-content;-ms-grid-columns:auto max-content max-content;grid-template-columns:auto -webkit-max-content -webkit-max-content;grid-template-columns:auto max-content max-content}header>div .header-title h1{margin:0;padding:0 1rem}header>div .header-title h1 a,header>div .header-title h1 a:visited{border-bottom:none;color:var(--colour-black);font-family:sans-serif;font-size:2.5rem;font-size:32px;font-weight:700;margin:0;padding:0;text-decoration:none}</pre>
<div class="language-sass" tab="scss">
<pre class="language-sass">@import "scss/core/header/header;
</pre>
<pre class="language-sass">//- DS2 core (c) 2024 Alexander McIlwraith
//- Licensed under CC BY-SA 4.0 //- Licensed under CC BY-SA 4.0
$header-bg-color: var(--colour-grey-xxl) !default; $header-bg-color: var(--colour-grey-xxl) !default;
@ -100,7 +76,59 @@ $font-weight: 700 !default;
} }
} }
}</pre> }</pre>
</div> <pre class="language-css" data-tab="css">header {
</tabset> display: -ms-grid;
display: grid;
-ms-grid-rows: 1.75rem 3.5rem;
grid-template-rows: 1.75rem 3.5rem;
-ms-grid-column: 2;
-ms-grid-column-span: 2;
grid-column: 2/4;
overflow: hidden;
}
header svg {
grid-column: 1/-1;
grid-row: 1/-1;
-ms-grid-row-align: stretch;
-ms-grid-column-align: stretch;
place-self: stretch;
}
header svg text {
-webkit-transform: translate(-1rem, 7.25rem);
-ms-transform: translate(-1rem, 7.25rem);
transform: translate(-1rem, 7.25rem);
font-size: 10rem;
font-weight: 1000;
font-family: sans-serif;
fill: var(--colour-grey-xxl);
}
header > div {
-ms-grid-row: 2;
grid-row: 2;
grid-column: 1/-1;
display: -ms-grid;
display: grid;
grid-column-gap: 1rem;
-ms-grid-columns: auto -webkit-max-content -webkit-max-content;
-ms-grid-columns: auto max-content max-content;
grid-template-columns: auto -webkit-max-content -webkit-max-content;
grid-template-columns: auto max-content max-content;
}
header > div .header-title h1 {
margin: 0;
padding: 0 1rem;
}
header > div .header-title h1 a, header > div .header-title h1 a:visited {
border-bottom: none;
color: var(--colour-black);
font-family: sans-serif;
font-size: 2.5rem;
font-size: 32px;
font-weight: 700;
margin: 0;
padding: 0;
text-decoration: none;
}</pre>
</div>
</body> </body>
</html> </html>

68
public/patterns/core/status/index.html
View File

@ -34,11 +34,11 @@
</tr> </tr>
<tr> <tr>
<td><a href="./?p=components/switch"> Switch</a></td> <td><a href="./?p=components/switch"> Switch</a></td>
<td><span class="status-complete">Complete</span></td> <td><span class="status-in-progress">In progress</span></td>
</tr> </tr>
<tr> <tr>
<td><a href="./?p=components/tooltip"> Tooltip</a></td> <td><a href="./?p=components/tooltip"> Tooltip</a></td>
<td><span class="status-complete">Complete</span></td> <td><span class="status-in-progress">In progress</span></td>
</tr> </tr>
</tr> </tr>
<tr> <tr>
@ -49,15 +49,15 @@
<td><span class="status-complete">Complete</span></td> <td><span class="status-complete">Complete</span></td>
<tr> <tr>
<td><a href="./?p=layouts/header"> Header</a></td> <td><a href="./?p=layouts/header"> Header</a></td>
<td><span class="status-complete">Complete</span></td> <td><span class="status-in-progress">In progress</span></td>
</tr> </tr>
<tr> <tr>
<td><a href="./?p=layouts/breakpoints"> Breakpoints</a></td> <td><a href="./?p=layouts/breakpoints"> Breakpoints</a></td>
<td><span class="status-complete">Complete</span></td> <td><span class="status-in-progress">In progress</span></td>
</tr> </tr>
<tr> <tr>
<td><a href="./?p=layouts/tabs"> Tabs</a></td> <td><a href="./?p=layouts/tabs"> Tabs</a></td>
<td><span class="status-complete">Complete</span></td> <td><span class="status-in-progress">In progress</span></td>
</tr> </tr>
</tr> </tr>
<tr> <tr>
@ -77,39 +77,16 @@
<td colspan="2"><span class="status-not-started">Not started (0)</span></td> <td colspan="2"><span class="status-not-started">Not started (0)</span></td>
</tr> </tr>
<tr> <tr>
<td colspan="2"><span class="status-in-progress">In progress (0)</span></td> <td colspan="2"><span class="status-in-progress">In progress (5)</span></td>
</tr>
<tr>
<td colspan="2"><span class="status-complete">Complete (10)</span></td>
</tr> </tr>
<tr> <tr>
<td> <a href="./?p=layouts/breakpoints">Breakpoints</a></td> <td> <a href="./?p=layouts/breakpoints">Breakpoints</a></td>
<td>Layouts</td> <td>Layouts</td>
</tr> </tr>
<tr>
<td> <a href="./?p=colours">Colours</a></td>
<td></td>
</tr>
<tr>
<td> <a href="./?p=components">Components</a></td>
<td></td>
</tr>
<tr> <tr>
<td> <a href="./?p=layouts/header">Header</a></td> <td> <a href="./?p=layouts/header">Header</a></td>
<td>Layouts</td> <td>Layouts</td>
</tr> </tr>
<tr>
<td> <a href="./?p=layouts">Layouts</a></td>
<td></td>
</tr>
<tr>
<td> <a href="./?p=status">Status</a></td>
<td></td>
</tr>
<tr>
<td> <a href="./?p=components/sticky-note">Sticky note</a></td>
<td>Components</td>
</tr>
<tr> <tr>
<td> <a href="./?p=components/switch">Switch</a></td> <td> <a href="./?p=components/switch">Switch</a></td>
<td>Components</td> <td>Components</td>
@ -122,6 +99,29 @@
<td> <a href="./?p=components/tooltip">Tooltip</a></td> <td> <a href="./?p=components/tooltip">Tooltip</a></td>
<td>Components</td> <td>Components</td>
</tr> </tr>
<tr>
<td colspan="2"><span class="status-complete">Complete (5)</span></td>
</tr>
<tr>
<td> <a href="./?p=colours">Colours</a></td>
<td></td>
</tr>
<tr>
<td> <a href="./?p=components">Components</a></td>
<td></td>
</tr>
<tr>
<td> <a href="./?p=layouts">Layouts</a></td>
<td></td>
</tr>
<tr>
<td> <a href="./?p=status">Status</a></td>
<td></td>
</tr>
<tr>
<td> <a href="./?p=components/sticky-note">Sticky note</a></td>
<td>Components</td>
</tr>
<tr> <tr>
<td colspan="2"><span class="status-deprecated">Deprecated (1)</span></td> <td colspan="2"><span class="status-deprecated">Deprecated (1)</span></td>
</tr> </tr>
@ -137,7 +137,7 @@
<tbody> <tbody>
<tr> <tr>
<td> <a href="./?p=layouts/breakpoints">Breakpoints</a></td> <td> <a href="./?p=layouts/breakpoints">Breakpoints</a></td>
<td><span><span class="status-complete">Complete</span></span></td> <td><span><span class="status-in-progress">In Progress</span></span></td>
<td>Layouts</td> <td>Layouts</td>
</tr> </tr>
<tr> <tr>
@ -152,7 +152,7 @@
</tr> </tr>
<tr> <tr>
<td> <a href="./?p=layouts/header">Header</a></td> <td> <a href="./?p=layouts/header">Header</a></td>
<td><span><span class="status-complete">Complete</span></span></td> <td><span><span class="status-in-progress">In Progress</span></span></td>
<td>Layouts</td> <td>Layouts</td>
</tr> </tr>
<tr> <tr>
@ -172,12 +172,12 @@
</tr> </tr>
<tr> <tr>
<td> <a href="./?p=components/switch">Switch</a></td> <td> <a href="./?p=components/switch">Switch</a></td>
<td><span><span class="status-complete">Complete</span></span></td> <td><span><span class="status-in-progress">In Progress</span></span></td>
<td>Components</td> <td>Components</td>
</tr> </tr>
<tr> <tr>
<td> <a href="./?p=layouts/tabs">Tabs</a></td> <td> <a href="./?p=layouts/tabs">Tabs</a></td>
<td><span><span class="status-complete">Complete</span></span></td> <td><span><span class="status-in-progress">In Progress</span></span></td>
<td>Layouts</td> <td>Layouts</td>
</tr> </tr>
<tr> <tr>
@ -187,7 +187,7 @@
</tr> </tr>
<tr> <tr>
<td> <a href="./?p=components/tooltip">Tooltip</a></td> <td> <a href="./?p=components/tooltip">Tooltip</a></td>
<td><span><span class="status-complete">Complete</span></span></td> <td><span><span class="status-in-progress">In Progress</span></span></td>
<td>Components</td> <td>Components</td>
</tr> </tr>
</tbody> </tbody>

150
public/patterns/core/sticky-note/index.html
View File

@ -9,23 +9,143 @@
<h2>When to use it</h2> <h2>When to use it</h2>
<p>Use a sticky when you want to make a note without adding it to the content. </p> <p>Use a sticky when you want to make a note without adding it to the content. </p>
<h2>How to use it</h2> <h2>How to use it</h2>
<p>Uses absolute positioning. Passing an optional element to the init function will initialise tabs within that element. You can move the position using either <code class="language-html inline">float="&#91; right | left &#93;"</code> or <code class="language-html inline">offset="&#91; top | left &#93;"</code>. Offset will take negative values in any web measurement unit. <p>Uses absolute positioning.
<sticky-note class="blue" offset="-10rem 1rem">This <strong>is</strong> a sample sticky. You can drag it out of the way if you need to see the content under it.</sticky-note> <sticky-note class="blue" float="right">This <strong>is</strong> a sample sticky. You can drag it out of the way if you need to see the content under it.</sticky-note>
<sticky-note float="right">You will notice when you hover over the sticky, it shows a dot in the colour of the sticky in the position where the sticky note refers to (assuming you haven't dragged it and scrolled that location off the screen).</sticky-note>
</p> </p>
<p>If you wish to create a custom element, that extends another HTML element, the native element has to be extended in customElements.define(). Custom elements that inherit native elements are also known as "type extension custom elements". </p> <p>If you wish to create a custom element, that extends another HTML element, the native element has to be extended in customElements.define(). Custom elements that inherit native elements are also known as "type extension custom elements". </p>
<sticky-note>You will notice when you hover over the sticky, it shows a dot in the colour of the sticky in the position where the sticky note refers to (assuming you haven't dragged it and scrolled that location off the screen).</sticky-note>
<tabset id="sticky-note"> <tabset id="sticky-note">
<pre class="language-html" tab="html"> <pre class="language-html" tab="html">
<sticky-note class="blue" float="right">This <strong>is</strong> a sample sticky. You can drag it out of the way if you need to see the content under it.</sticky-note></pre> <sticky-note class="blue" float="right">This <strong>is</strong> a sample sticky. You can drag it out of the way if you need to see the content under it.</sticky-note></pre>
<pre class="language-pug" tab="pug">sticky-note(float="right").blue This #[strong is] a sample sticky. <pre class="language-pug" tab="pug">sticky-note(float="right").blue This <strong>is</strong> a sample sticky.
| You can drag it out of the way if you need to see the content under it.</pre> | You can drag it out of the way if you need to see the content under it.</pre>
<pre class="language-css" data-tab="css"> @import url("https://fonts.googleapis.com/css2?family=Kalam:wght@300;400;700&display=swap");sticky-note-wrapper{-webkit-box-sizing:border-box;box-sizing:border-box;border:1px solid transparent;border-radius:50%;display:inline-block;height:0.5rem;position:relative;width:0.5rem}sticky-note-wrapper *{-webkit-box-sizing:border-box;box-sizing:border-box}sticky-note-wrapper sticky-note{cursor:-webkit-grab;cursor:grab;display:-ms-grid;display:grid;float:left;font-size:1rem;height:13rem;left:0;place-items:stretch;position:absolute;top:0;width:13rem;z-index:100}sticky-note-wrapper sticky-note:active{cursor:-webkit-grabbing;cursor:grabbing;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}sticky-note-wrapper sticky-note.right{float:right}sticky-note-wrapper sticky-note>div{-ms-grid-row:1;grid-row:1;-ms-grid-column:1;grid-column:1}sticky-note-wrapper sticky-note>div:first-child{background-color:rgba(0,0,0,0.25);-webkit-box-shadow:-2px 2px 15px 0 rgba(0,0,0,0.5);box-shadow:-2px 2px 15px 0 rgba(0,0,0,0.5);display:-ms-grid;display:grid;margin:2rem 1rem 0.25rem 0.36rem;width:calc(100% - 1rem)}sticky-note-wrapper sticky-note>div:nth-child(2){clip-path:url(#stickyClip);display:-ms-grid;display:grid;font-family:"Kalam",cursive;font-style:1rem;font-weight:300;line-height:1.25rem;padding:1rem;place-items:center;text-align:center}sticky-note-wrapper sticky-note>div:nth-child(2)>*{font-family:"Kalam",cursive!important;font-style:normal!important;font-weight:300!important}@media screen and (max-width:1024px){sticky-note-wrapper sticky-note>div:nth-child(2){max-width:13rem;min-width:13rem;width:1rem}}@media screen and (max-width:768px){sticky-note-wrapper sticky-note>div:nth-child(2){font-size:1.75rem;max-width:21rem;min-height:21rem}}@media screen and (max-width:640px){sticky-note-wrapper sticky-note>div:nth-child(2){font-size:2.5rem;max-width:26rem;min-height:26rem}}sticky-note-wrapper sticky-note>div:nth-child(2){background:-webkit-gradient(linear,left top,left bottom,from(#ffffdd),color-stop(2%,#ffffd3),color-stop(12%,#ffffd3),color-stop(75%,#ffffc9),to(#ffffba));background:linear-gradient(180deg,#ffffdd 0%,#ffffd3 2%,#ffffd3 12%,#ffffc9 75%,#ffffba 100%)}sticky-note-wrapper sticky-note.blue>div:nth-child(2){background:-webkit-gradient(linear,left top,left bottom,from(#9dddec),color-stop(2%,#94daea),color-stop(12%,#94daea),color-stop(75%,#8bd7e8),to(#7fd3e6));background:linear-gradient(180deg,#9dddec 0%,#94daea 2%,#94daea 12%,#8bd7e8 75%,#7fd3e6 100%)}sticky-note-wrapper sticky-note.pink>div:nth-child(2){background:-webkit-gradient(linear,left top,left bottom,from(#fa7c93),color-stop(2%,#fa728b),color-stop(12%,#fa728b),color-stop(75%,#fa6883),to(#f95977));background:linear-gradient(180deg,#fa7c93 0%,#fa728b 2%,#fa728b 12%,#fa6883 75%,#f95977 100%)}sticky-note-wrapper sticky-note.green>div:nth-child(2){background:-webkit-gradient(linear,left top,left bottom,from(#c5fcc9),color-stop(2%,#bbfbc0),color-stop(12%,#bbfbc0),color-stop(75%,#b1fab7),to(#a3faaa));background:linear-gradient(180deg,#c5fcc9 0%,#bbfbc0 2%,#bbfbc0 12%,#b1fab7 75%,#a3faaa 100%)}sticky-note-wrapper:has(sticky-note:hover){background-color:#ffffd3;border:1px solid black}sticky-note-wrapper:has(sticky-note.yellow:hover){background-color:#ffffd3}sticky-note-wrapper:has(sticky-note.blue:hover){background-color:#94daea}sticky-note-wrapper:has(sticky-note.pink:hover){background-color:#fa728b}sticky-note-wrapper:has(sticky-note.green:hover){background-color:#bbfbc0}</pre> <pre class="language-css" data-tab="css"> @import url("https://fonts.googleapis.com/css2?family=Kalam:wght@300;400;700&display=swap");
<div tab="scss"> sticky-note-wrapper {
<pre class="language-sass">$sticky-colors: ( [sass map with your own defined colours] ); -webkit-box-sizing: border-box;
@import "scss/core/switch/_sticky-note"; box-sizing: border-box;
@include sticky-note; border: 1px solid transparent;
</pre> border-radius: 50%;
<pre class="language-sass">//- DS2 core (c) 2024 Alexander McIlwraith display: inline-block;
height: 0.5rem;
position: relative;
width: 0.5rem;
}
sticky-note-wrapper * {
-webkit-box-sizing: border-box;
box-sizing: border-box;
}
sticky-note-wrapper sticky-note {
cursor: -webkit-grab;
cursor: grab;
display: -ms-grid;
display: grid;
float: left;
font-size: 1rem;
height: 13rem;
left: 0;
place-items: stretch;
position: absolute;
top: 0;
width: 13rem;
z-index: 100;
}
sticky-note-wrapper sticky-note:active {
cursor: -webkit-grabbing;
cursor: grabbing;
-webkit-user-select: none;
-moz-user-select: none;
-ms-user-select: none;
user-select: none;
}
sticky-note-wrapper sticky-note.right {
float: right;
}
sticky-note-wrapper sticky-note > div {
-ms-grid-row: 1;
grid-row: 1;
-ms-grid-column: 1;
grid-column: 1;
}
sticky-note-wrapper sticky-note > div:nth-child(1) {
background-color: rgba(0, 0, 0, 0.25);
-webkit-box-shadow: -2px 2px 15px 0 rgba(0, 0, 0, 0.5);
box-shadow: -2px 2px 15px 0 rgba(0, 0, 0, 0.5);
display: -ms-grid;
display: grid;
margin: 2rem 1rem 0.25rem 0.36rem;
width: calc(100% - 1rem);
}
sticky-note-wrapper sticky-note > div:nth-child(2) {
clip-path: url(#stickyClip);
display: -ms-grid;
display: grid;
font-family: "Kalam", cursive;
font-style: 1rem;
font-weight: 300;
line-height: 1.25rem;
padding: 1rem;
place-items: center;
text-align: center;
}
sticky-note-wrapper sticky-note > div:nth-child(2) > * {
font-family: "Kalam", cursive !important;
font-style: normal !important;
font-weight: 300 !important;
}
@media screen and (max-width: 1024px) {
sticky-note-wrapper sticky-note > div:nth-child(2) {
max-width: 13rem;
min-width: 13rem;
width: 1rem;
}
}
@media screen and (max-width: 768px) {
sticky-note-wrapper sticky-note > div:nth-child(2) {
font-size: 1.75rem;
max-width: 21rem;
min-height: 21rem;
}
}
@media screen and (max-width: 640px) {
sticky-note-wrapper sticky-note > div:nth-child(2) {
font-size: 2.5rem;
max-width: 26rem;
min-height: 26rem;
}
}
sticky-note-wrapper sticky-note > div:nth-child(2) {
background: -webkit-gradient(linear, left top, left bottom, from(#ffffdd), color-stop(2%, #ffffd3), color-stop(12%, #ffffd3), color-stop(75%, #ffffc9), to(#ffffba));
background: linear-gradient(180deg, #ffffdd 0%, #ffffd3 2%, #ffffd3 12%, #ffffc9 75%, #ffffba 100%);
}
sticky-note-wrapper sticky-note.blue > div:nth-child(2) {
background: -webkit-gradient(linear, left top, left bottom, from(#9dddec), color-stop(2%, #94daea), color-stop(12%, #94daea), color-stop(75%, #8bd7e8), to(#7fd3e6));
background: linear-gradient(180deg, #9dddec 0%, #94daea 2%, #94daea 12%, #8bd7e8 75%, #7fd3e6 100%);
}
sticky-note-wrapper sticky-note.pink > div:nth-child(2) {
background: -webkit-gradient(linear, left top, left bottom, from(#fa7c93), color-stop(2%, #fa728b), color-stop(12%, #fa728b), color-stop(75%, #fa6883), to(#f95977));
background: linear-gradient(180deg, #fa7c93 0%, #fa728b 2%, #fa728b 12%, #fa6883 75%, #f95977 100%);
}
sticky-note-wrapper sticky-note.green > div:nth-child(2) {
background: -webkit-gradient(linear, left top, left bottom, from(#c5fcc9), color-stop(2%, #bbfbc0), color-stop(12%, #bbfbc0), color-stop(75%, #b1fab7), to(#a3faaa));
background: linear-gradient(180deg, #c5fcc9 0%, #bbfbc0 2%, #bbfbc0 12%, #b1fab7 75%, #a3faaa 100%);
}
sticky-note-wrapper:has(sticky-note:hover) {
background-color: #ffffd3;
border: 1px solid black;
}
sticky-note-wrapper:has(sticky-note.yellow:hover) {
background-color: #ffffd3;
}
sticky-note-wrapper:has(sticky-note.blue:hover) {
background-color: #94daea;
}
sticky-note-wrapper:has(sticky-note.pink:hover) {
background-color: #fa728b;
}
sticky-note-wrapper:has(sticky-note.green:hover) {
background-color: #bbfbc0;
}</pre>
<pre class="language-css" data-tab="scss"> //- DS2 core (c) 2024 Alexander McIlwraith
//- Licensed under CC BY-SA 4.0 //- Licensed under CC BY-SA 4.0
@use 'sass:color'; @use 'sass:color';
@ -177,12 +297,7 @@ $sticky-colors: (
} }
} }
}</pre> }</pre>
</div> <pre class="language-js" data-tab="js"> //- DS2 core (c) 2024 Alexander McIlwraith
<div tab="js">
<pre class="language-js">import * as stickynote from ""./js/core/sticky-note/_sticky-note.js";
stickynote.init()
</pre>
<pre class="language-js">//- DS2 core (c) 2024 Alexander McIlwraith
//- Licensed under CC BY-SA 4.0 //- Licensed under CC BY-SA 4.0
const font = { const font = {
@ -313,7 +428,6 @@ export function init(p = document){
}); });
} }
}</pre> }</pre>
</div>
</tabset> </tabset>
</body> </body>
</html> </html>

77
public/patterns/core/switch/index.html
View File

@ -5,32 +5,50 @@
</head> </head>
<body data-prismjs-copy-timeout="1500"> <body data-prismjs-copy-timeout="1500">
<h2>What is it</h2> <h2>What is it</h2>
<p>Switches are used to toggle application state between two mutually exclusive values. </p> <p>Switches are used to toggle application state between two mutually exlusive values. </p>
<h2>When to use it</h2> <h2>When to use it</h2>
<p>Use a switch when the user will see an immediate visible state change. Do not use a switch when the state change will affect future results. The user should not have to perform another action (search, save, etc) for the result to take affect. If the change in state does not take effect immediately, consider a checkbox. </p>
<h2>How to use it</h2> <h2>How to use it</h2>
<p>The switch label should describe what will happen when the switch is turned to the on state. Frontload labels with keywords. </p>
<p>Include the CSS and JavaScript. An additional handler will need to be created for the actual state change. The CSS implements the visual design of the switch, which is based on the accessibility properties, which are implemented by the JavaScript.</p>
<h2>Example</h2> <h2>Example</h2>
<p class="switch"> <p class="switch">
<label for="example-switch">Switch label (states the on state)</label><span id="example-switch" role="switch"></span> <label for="example-switch">Switch label</label><span id="example-switch" role="switch"></span>
</p> </p>
<div class="tab-group" id="switches"> <div class="tab-group" id="switches">
<pre class="language-html" tab="html"><span id="example-id" role="switch"></span></pre> <pre class="language-html" data-tab="html"><span id="example-id" role="switch"></span></pre>
<pre class="language-pug" tab="pug">span#example-id(role="switch")</pre> <pre class="language-pug" data-tab="pug">span#example-id(role="switch")</pre>
<pre class="language-css" tab="css">[role=switch]{display:-ms-inline-grid;display:inline-grid;border:1px solid #2e51a1;background-color:#d8d8d8;border-radius:0.75rem;height:1.5rem;width:3rem;-webkit-transition:all 500ms;transition:all 500ms}[role=switch]>span{display:inline-block;background-color:white;border-radius:50%;margin:2%;width:calc(1.5rem - 2%);-webkit-transition:all 500ms;transition:all 500ms}[role=switch][aria-checked=true]{background-color:#2e51a1}[role=switch][aria-checked=true]>span{margin-left:calc(1.5rem - 5%)}</pre> <pre class="language-css" data-tab="css">[role=switch] {
<div tab="scss"> display: -ms-inline-grid;
<pre class="language-sass">@import "scss/core/switch/_switch"; display: inline-grid;
@include switch; border: 1px solid var(--colour-blue);
</pre> background-color: var(--colour-grey-xl);
<pre class="language-sass">//- DS2 core (c) 2024 Alexander McIlwraith border-radius: 0.75rem;
height: 1.5rem;
width: 3rem;
-webkit-transition: all 500ms;
transition: all 500ms;
}
[role=switch] > span {
display: inline-block;
background-color: white;
border-radius: 50%;
margin: 2%;
width: calc(1.5rem - 2%);
-webkit-transition: all 500ms;
transition: all 500ms;
}
[role=switch][aria-checked=true] {
background-color: var(--colour-blue);
}
[role=switch][aria-checked=true] > span {
margin-left: calc(1.5rem - 5%);
}</pre>
<pre class="language-css" data-tab="scss">//- DS2 core (c) 2024 Alexander McIlwraith
//- Licensed under CC BY-SA 4.0 //- Licensed under CC BY-SA 4.0
@use "sass:math"; @use "sass:math";
$switch-accent: #2e51a1 !default; // switch background when switched right (on/ true) $switch-accent: var(--colour-blue) !default; // switch background when switched right (on/ true)
$switch-background: #d8d8d8 !default; // switch background when switched left (off / false) $switch-background: var(--colour-grey-xl) !default; // switch background when switched left (off / false)
$switch-color: white !default; // the colour of the switch $switch-color: var(--colour-white) !default; // the colour of the switch
$switch-height: 1.5rem !default; $switch-height: 1.5rem !default;
@mixin switch { @mixin switch {
@ -59,13 +77,7 @@ $switch-height: 1.5rem !default;
} }
} }
}</pre> }</pre>
</div> <pre class="language-js" data-tab="js">//- DS2 core (c) 2024 Alexander McIlwraith
<div tab="js">
<pre class="language-js">// Note that switch is a reserved word.
import * as swtch from "./js/core/switch/_switch.js";
swtch.init();
</pre>
<pre class="language-js">//- DS2 core (c) 2024 Alexander McIlwraith
//- Licensed under CC BY-SA 4.0 //- Licensed under CC BY-SA 4.0
function flip(e) { function flip(e) {
@ -82,21 +94,16 @@ function flip(e) {
module.exports = { module.exports = {
init: (p = document) => { init: (p = document) => {
try { p.querySelectorAll("[role='switch']").forEach((sw) => {
p.querySelectorAll("[role='switch']").forEach((sw) => { sw.innerHTML = "<span></span>";
sw.innerHTML = "<span></span>"; sw.setAttribute("aria-checked", "false");
sw.setAttribute("aria-checked", "false"); sw.setAttribute("tabindex", "0");
sw.setAttribute("tabindex", "0"); sw.addEventListener("click", flip, false);
sw.addEventListener("click", flip, false); sw.addEventListener("keypress", flip, false);
sw.addEventListener("keypress", flip, false); })
})
} catch (e) {
console.warn("Cannot initialise switches.", e);
}
} }
} }
</pre> </pre>
</div>
</div> </div>
</body> </body>
</html> </html>

155
public/patterns/core/tabs/index.html
View File

@ -2,18 +2,11 @@
<html> <html>
<head> <head>
<title>Pattern</title> <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> </head>
<body data-prismjs-copy-timeout="1500"> <body data-prismjs-copy-timeout="1500">
<h2>What is it</h2> <h2>What is it</h2>
<p>A tabs component that provides different sections of content that are displayed one at a time when the user selects that information. </p>
<h2>When to use it</h2> <h2>When to use it</h2>
<h2>How to use it</h2>
<p>The tabbed user interface enables users to jump to their target section quickly. Tabs present like logically group information on the same page. Information should </p> <p>The tabbed user interface enables users to jump to their target section quickly. Tabs present like logically group information on the same page. Information should </p>
<ul> <ul>
<li>be logically chunked and ordered</li> <li>be logically chunked and ordered</li>
@ -22,26 +15,13 @@
<li>obvious where they begin and end </li> <li>obvious where they begin and end </li>
</ul> </ul>
<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> <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 tab module can be initialised by importing a file with the javascript module using import * as tabs from "../pg/patterns/layouts/tabs/_tabs.js"; contains a modularized version of the jQuery code, so that it can be called on demand. It is what is used in the design system so that the JavaScript can be called at run time (after loading content).</p>
<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"> <tabset id="tabs">
<pre class="language-html" tab="html"> <pre class="language-html" tab="html">
<tabset id="uniqueID"> <div class="tab-group" id="uniqueID">
<div tab="[tab title]"></div> <div data-tab="[tab title]"></div>
<div tab="[tab title]"></div> <div data-tab="[tab title]"></div>
</tabset></pre> </div></pre>
<pre class="language-pug" tab="pug">tabset#uniqueID
div(tab="[tab title]")
div(tab="[tab title]")
</pre>
<pre class="language-css" tab="css">tabset, .tab-group { <pre class="language-css" tab="css">tabset, .tab-group {
margin: 2rem 0 1rem 0; margin: 2rem 0 1rem 0;
} }
@ -53,8 +33,8 @@ tabset > ul, .tab-group > ul {
padding: 0; padding: 0;
} }
tabset > ul li.separator, .tab-group > ul li.separator { tabset > ul li.separator, .tab-group > ul li.separator {
border-bottom: 1px solid #7f7f7f; border-bottom: 1px solid var(--colour-grey);
border-left: 1px solid #7f7f7f; border-left: 1px solid var(--colour-grey);
display: inline-block; display: inline-block;
margin: 0.45rem 0 0 0; margin: 0.45rem 0 0 0;
width: 100%; width: 100%;
@ -63,9 +43,9 @@ tabset .tab-hidden, .tab-group .tab-hidden {
display: none; display: none;
} }
tabset [role=tab], .tab-group [role=tab] { tabset [role=tab], .tab-group [role=tab] {
background-color: #FFF; background-color: var(--colour-white);
border-left: 1px solid #7f7f7f; border-left: 1px solid var(--colour-grey);
border-top: 1px solid #7f7f7f; border-top: 1px solid var(--colour-grey);
border-radius: 0.5rem 0.5rem 0 0; border-radius: 0.5rem 0.5rem 0 0;
cursor: pointer; cursor: pointer;
margin: 0; margin: 0;
@ -74,19 +54,19 @@ tabset [role=tab], .tab-group [role=tab] {
z-index: 2; z-index: 2;
} }
tabset [role=tab]:last-of-type, .tab-group [role=tab]:last-of-type { tabset [role=tab]:last-of-type, .tab-group [role=tab]:last-of-type {
border-right: 1px solid #7f7f7f; border-right: 1px solid var(--colour-grey);
} }
tabset [role=tab]:not(.selected), .tab-group [role=tab]:not(.selected) { tabset [role=tab]:not(.selected), .tab-group [role=tab]:not(.selected) {
background-color: #f0f0f0; background-color: var(--colour-grey-xxl);
border-bottom: 1px solid #7f7f7f; border-bottom: 1px solid var(--colour-grey);
} }
tabset [role=tab] span, .tab-group [role=tab] span { tabset [role=tab] span, .tab-group [role=tab] span {
display: block; display: block;
margin: 0 0 0.5rem 0; margin: 0 0 0.5rem 0;
} }
tabset [role=tabpanel], .tab-group [role=tabpanel] { tabset [role=tabpanel], .tab-group [role=tabpanel] {
background-color: #FFF; background-color: var(--colour-white);
border: 1px solid #7f7f7f; border: 1px solid var(--colour-grey);
border-top: none; border-top: none;
padding: 1rem; padding: 1rem;
z-index: 1; z-index: 1;
@ -94,18 +74,12 @@ tabset [role=tabpanel], .tab-group [role=tabpanel] {
tabset [role=tabpanel]:not(.open), .tab-group [role=tabpanel]:not(.open) { tabset [role=tabpanel]:not(.open), .tab-group [role=tabpanel]:not(.open) {
display: none; display: none;
}</pre> }</pre>
<div tab="scss"> <pre class="language-css" tab="scss">// DS2 core (c) 2024 Alexander McIlwraith
<pre class="language-sass">@import "scss/core/tabs/_tabs";
@include tabs{
// optional content block
};
</pre>
<pre class="language-sass">// DS2 core (c) 2024 Alexander McIlwraith
// Licensed under CC BY-SA 4.0 // Licensed under CC BY-SA 4.0
$tab-border: #7f7f7f !default; $tab-border: var(--colour-grey) !default;
$tab-selected: #FFF !default; $tab-selected: var(--colour-white) !default;
$tab-notselected: #f0f0f0 !default; $tab-notselected: var(--colour-grey-xxl) !default;
@mixin tabs { @mixin tabs {
tabset, .tab-group { tabset, .tab-group {
@ -169,46 +143,13 @@ $tab-notselected: #f0f0f0 !default;
} }
} }
}</pre> }</pre>
</div> <pre class="language-css" tab="js">/* DS2 core (c) 2024 Alexander McIlwraith
<div tab="js"> import * as tabs from "../pg/patterns/layouts/tabs/_tabs.js";
<pre class="language-js">import * as tabs from "./js/core/tabs/_tabs.js"; tabs.init();
tabs.init();</pre>
<pre class="language-js">/* DS2 core (c) 2024 Alexander McIlwraith
Released under Creative Commons Attribution-ShareAlike 4.0 International
*/ */
// create a pure JS mouse click event export function init(p = document) {
const click = new MouseEvent('click', { p.querySelectorAll(".tab-group, tabset").forEach(tabGroup => {
view: window,
bubbles: false,
cancelable: true
});
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) { if (tabGroup.querySelector("[role=tablist]") === null) {
const tabgroup = tabGroup.getAttribute("id"); const tabgroup = tabGroup.getAttribute("id");
@ -234,52 +175,28 @@ export function init(container = document, spacer = true, args = {}) {
const ul = document.createElement('ul'); const ul = document.createElement('ul');
ul.setAttribute("role", "tablist"); ul.setAttribute("role", "tablist");
ul.innerHTML = spacer != true ? `${tablist}` : `${tablist}<li role="separator" class="separator"></li>`; ul.innerHTML = `${tablist}<li role="separator" class="separator"></li>`;
tabGroup.insertBefore(ul, tabGroup.firstChild); tabGroup.insertBefore(ul, tabGroup.firstChild);
tabGroup.querySelectorAll('[role="tab"]').forEach(tab => { tabGroup.querySelectorAll('[role="tab"]').forEach(tab => {
tab.addEventListener("click", (e) => { tab.addEventListener("click", () => {
if (e.altKey && typeof args.altModifier == "function") { const siblings = Array.from(tab.parentNode.children);
args.altModifier(tab); siblings.forEach(sibling => sibling.classList.remove("selected"));
} else if (e.shiftKey && typeof args.shiftModifier == "function") { tab.classList.add("selected");
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) const tabPanels = Array.from(tab.parentNode.parentNode.children)
.filter(child => child.getAttribute("role") === "tabpanel"); .filter(child => child.getAttribute("role") === "tabpanel");
tabPanels.forEach(panel => panel.classList.remove("open")); tabPanels.forEach(panel => panel.classList.remove("open"));
const tabPanelId = tab.getAttribute("id").replace("tab", "tab-panel"); const tabPanelId = tab.getAttribute("id").replace("tab", "tab-panel");
document.getElementById(tabPanelId).classList.add("open"); document.getElementById(tabPanelId).classList.add("open");
}
}); });
tab.addEventListener("keypress", (e) => {
e.preventDefault();
if( e.which == 32 || e.which == 13 ) {
e.currentTarget.dispatchEvent(click);
}
})
}); });
}
if (document.location.hash != "" && document.location.hash.substring(0,5) == "#tab-") {
waitForElement(document.location.hash).then((el) => {
el.scrollIntoView();
el.dispatchEvent(click);
});
} }
}); });
} }
</pre> </pre>
</div>
</tabset> </tabset>
</body> </body>
</html> </html>

32
public/patterns/core/tooltip/index.html
View File

@ -5,15 +5,9 @@
</head> </head>
<body data-prismjs-copy-timeout="1500"> <body data-prismjs-copy-timeout="1500">
<h2>What is it</h2> <h2>What is it</h2>
<p>Tooltips provide brief information messaging through a mouse or keyboard hover. </p>
<h2>When to use it</h2> <h2>When to use it</h2>
<p>Use tool tips to provide additional information. Don't use tooltips for that is required to complete an interaction as the information disappears when it loses the hover state. </p>
<p>Use tooltips to help differentiate between multiple, close, similar options. </p>
<h2>How to use it</h2> <h2>How to use it</h2>
<p class="notification-box info">Currently, there is no easy way to activate a hover without with pure CSS without using a keyboard or mouse. Level4 media queries aim to solve that.</p> <p>Either form works. Place this inside another element for the tooltip to be "linked to that element."</p>
<p>Either form works.
<sticky-note class="blue">"Either form works": What are the two forms.</sticky-note>Place the <code class="language-html inline">tooltip</code> inside another element for the tooltip to be 'linked to that element.' A container element may need to be added for a single tag element, such as a input field.
</p>
<p>Tool tip positions are: </p> <p>Tool tip positions are: </p>
<ul> <ul>
<li>top / block-start</li> <li>top / block-start</li>
@ -21,12 +15,16 @@
<li>bottom / block-end</li> <li>bottom / block-end</li>
<li>left / inline-start</li> <li>left / inline-start</li>
</ul> </ul>
<p><a href="#">Link with a tool tip<span role="tooltip" inert="inert" tip-position="right">Tool tip content</span></a></p> <div class="tab-group" id="tooltip">
<tabset id="tooltip"> <pre class="language-html" data-tab="html"><a href="#">Link with a tool tip
<pre class="language-html" tab="html"><a href="#">Link with a tool tip<span role="tooltip" inert="inert" tip-position="right">Tool tip content</span></a></pre> <div role="tooltip" inert="inert" tip-position="bottom">Tool tip content</div></a><a href="#">Link with a tool tip
<pre class="language-pug" tab="pug">a(href="#") Link with a tool tip <tool-tip role="tooltip" inert="inert" tip-position="bottom">Tool tip content</tool-tip></a></pre>
span(role="tooltip" inert tip-position="right") Tool tip content</pre> <pre class="language-pug" data-tab="pug">a(href="#") Link with a tool tip
<pre class="language-css" tab="css">/* Position Options div(role="tooltip" inert tip-position="bottom") Tool tip content
a(href="#") Link with a tool tip
tool-tip(role="tooltip" inert tip-position="bottom") Tool tip content</pre>
<pre class="language-css" data-tab="css">/* Position Options
- top / block-start - top / block-start
- right / inline-end - right / inline-end
- bottom / block-end - bottom / block-end
@ -181,10 +179,7 @@
--tooltip-x: calc(-1 * 3px * -1); --tooltip-x: calc(-1 * 3px * -1);
} }
}</pre> }</pre>
<div tab="scss"> <pre class="language-css" data-tab="scss">//- DS2 core (c) 2024 Alexander McIlwraith
<pre class="language-sass">@import "scss/core/tooltip/_tooltip";
@include tooltip;</pre>
<pre class="language-sass">//- DS2 core (c) 2024 Alexander McIlwraith
//- Licensed under CC BY-SA 4.0 //- Licensed under CC BY-SA 4.0
$tooltip-border-radius: .5rem !default; $tooltip-border-radius: .5rem !default;
@ -361,7 +356,6 @@ $tooltip-pointer-top: conic-gradient(from 150deg at top, rgba(0, 0, 0, 0), #000
} }
}</pre> }</pre>
</div> </div>
</tabset>
</body> </body>
</html> </html>

254
src/js/core/_core.js
View File

@ -21,7 +21,7 @@ const font = {
size: 0 size: 0
} }
const copyFallback = (copyInfo, attr) => { const copyColourFallback = (copyInfo, attr) => {
console.log("fallback") console.log("fallback")
var textArea = document.createElement('textarea'); var textArea = document.createElement('textarea');
textArea.value = copyInfo; textArea.value = copyInfo;
@ -71,6 +71,22 @@ const showMessage = (m, s) => {
}, 1000); }, 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 = () => { const getURLVars = () => {
var oResult = {}; var oResult = {};
if (location.search.length > 0) { if (location.search.length > 0) {
@ -86,19 +102,7 @@ const getURLVars = () => {
} }
module.exports = { module.exports = {
url: (() => { url: getURLVars(),
var v = {};
if (location.search.length > 0) {
var qs = (location.search.substr(1)).split("&");
for (var i = 0; i < qs.length; i++) {
var t = qs[i].split("=");
if (t[1].length > 0) {
v[t[0]] = decodeURIComponent(t[1].replace(/\+/g, '%20'));
}
}
}
return v;
})(),
cookie: { cookie: {
set: (name, value, expires, path, domain, secure) => { set: (name, value, expires, path, domain, secure) => {
switch(typeof expires) { switch(typeof expires) {
@ -129,26 +133,12 @@ module.exports = {
} }
return ""; return "";
}, },
remove: (cname) => { remove: (cnane) => {
module.exports.cookie.set(cname, null, new Date(null)); setCookie(cname, "", -1);
}, },
}, },
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: { colour: {
copy: (w, t) => { copy: (w, t) => {
let c = t.parentNode.getAttribute("data-" + (w=="var" ? "token" : w)); let c = t.parentNode.getAttribute("data-" + (w=="var" ? "token" : w));
c = w == "var" ? `var(${c})` : c; c = w == "var" ? `var(${c})` : c;
@ -157,10 +147,10 @@ module.exports = {
navigator.clipboard.writeText(c).then(function() { navigator.clipboard.writeText(c).then(function() {
showMessage(`Copied ${w}.`); showMessage(`Copied ${w}.`);
}, function(e) { }, function(e) {
copyFallback(c,w); copyColourFallback(c,w);
}); });
} else { } else {
copyFallback(c, w); copyColourFallback(c, w);
} }
}, },
@ -175,26 +165,6 @@ module.exports = {
}); });
}) })
} }
},
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 = {}) => { init: (args = {}) => {
const url = getURLVars(); const url = getURLVars();
@ -207,14 +177,7 @@ module.exports = {
if (url.p == -1) { if (url.p == -1) {
document.querySelector("title").innerHTML = `${url.p.toContent().toTitleCase()} | ${ document.querySelector("title").getAttribute("data-site") }`; document.querySelector("title").innerHTML = `${url.p.toContent().toTitleCase()} | ${ document.querySelector("title").getAttribute("data-site") }`;
} else { } else {
let theTitle = document.querySelectorAll("article"); document.querySelector("title").innerHTML = `${url.p.substring(url.p.lastIndexOf("/")+1).toContent().toTitleCase()} | ${ document.querySelector("title").getAttribute("data-site") }`
if (theTitle.length > 0) {
theTitle = theTitle[0].getAttribute("data-name").toContent().toTitleCase();
if (document.querySelector("article").getAttribute("data-display") !== null) {
theTitle = document.querySelector("article").getAttribute("data-display")
}
document.querySelector("title").innerHTML = `${theTitle} | ${ document.querySelector("title").getAttribute("data-site") }`
}
} }
} }
@ -222,103 +185,88 @@ module.exports = {
document.querySelectorAll("article").forEach((a) => { document.querySelectorAll("article").forEach((a) => {
if ( a.getAttribute("data-template") != "none" ) { if ( a.getAttribute("data-template") != "none" ) {
const observer = new IntersectionObserver(articles => { let path = a.getAttribute("data-path");
articles.forEach(article => { path = "patterns/" +
let a = article.target; (a.getAttribute("data-core") == "true" ?
"core/" + path.substring(path.lastIndexOf("/") + 1) :
if (article.isIntersecting == true) { a.getAttribute("data-path"))
let path = a.getAttribute("data-path"); + "/index.html";
path = "patterns/" + const ASYNC = true;
(a.getAttribute("data-core") == "true" ? let ajx = new XMLHttpRequest();
"core/" + path.substring(path.lastIndexOf("/") + 1) : ajx.onreadystatechange = () => {
a.getAttribute("data-path")) if (ajx.readyState == 4) {
+ "/index.html";
const ASYNC = true; switch (ajx.status) {
let ajx = new XMLHttpRequest(); case 200:
ajx.onreadystatechange = () => { a.innerHTML = a.innerHTML + ajx.responseText;
if (ajx.readyState == 4) {
observer.unobserve(article.target); switch (a.getAttribute("data-template")) {
switch (ajx.status) { case "pug":
case 200: a.querySelectorAll("pre").forEach((aa) => {
a.innerHTML = a.innerHTML + ajx.responseText; aa.innerHTML = `<code class="${aa.getAttribute("class")}">${aa.innerHTML}</code>`;
a.style.height = "auto" })
switch (a.getAttribute("data-template")) { break;
case "pug": case "md":
a.querySelectorAll("pre").forEach((aa) => { a.querySelectorAll("code").forEach((aa) => {
aa.innerHTML = `<code class="${aa.getAttribute("class")}">${aa.innerHTML}</code>`; aa.classList.add("language-html");
}) })
break; break;
case "md":
a.querySelectorAll("code").forEach((aa) => {
aa.classList.add("language-html");
})
break;
}
a.querySelectorAll("code").forEach((c)=> {
c.classList.add("line-numbers");
c.innerHTML = c.innerHTML.replace(/</g, "&lt;");
c.classList.add("copy-to-clipboard-button");
})
if (typeof args.success == "function") args.success(a);
Prism.highlightAll();
a.querySelectorAll("code").forEach((c)=> {
c.onclick = (e) => {
module.exports.oneClickSelect(e);
}
})
module.exports.colour.positionTooltip();
window.onresize = () => {
module.exports.colour.positionTooltip();
}
a.querySelectorAll("name > span, color-pill > span").forEach((pill) => {
pill.onclick = (e) => {
e.preventDefault();
let w = "";
if (e.metaKey || e.ctrlKey || e.keyCode == 91 || e.keyCode == 224) {
w = "var";
} else if (e.altKey) {
w = "token"
} else if (e.shiftKey) {
w = "rgb";
} else {
w = "hex";
}
module.exports.colour.copy(w, pill);
}
})
break;
case 404:
if (typeof args.notFound == "function") args.notFound(a, path);
break;
default:
console.log("uncaught http error", { status: ajx.status, path: a.getAttribute("data-path") });
}
a.style.height = "auto";
if (typeof args.done == "function") args.done(a);
} }
};
ajx.open("GET", path, ASYNC);
ajx.send();
a.querySelectorAll("code").forEach((c)=> {
c.classList.add("line-numbers");
c.innerHTML = c.innerHTML.replace(/</g, "&lt;");
c.classList.add("copy-to-clipboard-button");
})
if (typeof args.success == "function") args.success(a);
Prism.highlightAll();
a.querySelectorAll("code").forEach((c)=> {
c.onclick = (e) => {
oneClickSelect(e);
}
})
module.exports.colour.positionTooltip();
window.onresize = () => {
module.exports.colour.positionTooltip();
}
a.querySelectorAll("name > span, color-pill > span").forEach((pill) => {
pill.onclick = (e) => {
e.preventDefault();
let w = "";
if (e.metaKey || e.ctrlKey || e.keyCode == 91 || e.keyCode == 224) {
w = "var";
} else if (e.altKey) {
w = "token"
} else if (e.shiftKey) {
w = "rgb";
} else {
w = "hex";
}
module.exports.colour.copy(w, pill);
}
})
break;
case 404:
if (typeof args.notFound == "function") args.notFound(a, path);
break;
default:
console.log("uncaught http error", { status: ajx.status, path: a.getAttribute("data-path") });
} }
})
}, { threshold: 0, rootMargin: "100%" })
observer.observe(a); if (typeof args.done == "function") args.done(a);
} else { }
a.style.height = "auto"; };
ajx.open("GET", path, ASYNC);
ajx.send();
} }
}) })

43
src/js/scaffolding.js
View File

@ -12,12 +12,10 @@ import * as stickynote from "../pg/patterns/core/sticky-note/_sticky-note.js";
import * as swtch from "../pg/patterns/core/switch/_switch.js"; import * as swtch from "../pg/patterns/core/switch/_switch.js";
import * as tabs from "../pg/patterns/core/tabs/_tabs.js"; import * as tabs from "../pg/patterns/core/tabs/_tabs.js";
// init c // init core
core.init({ core.init({
success: (a) => { success: (a) => {
tabs.init(a, true, { tabs.init(a);
shiftModifier: core.getTabPath,
});
swtch.init(a); swtch.init(a);
stickynote.init(a); stickynote.init(a);
}, },
@ -27,23 +25,13 @@ core.init({
}); });
// deprecated switch handler // deprecated switch handler
const flipInfoSwitch = (e, s = e.currentTarget) => { const flipDeprecated = (e, s = e.currentTarget) => {
core.cookie.set("show-deprecated", s.getAttribute("aria-checked"), 30, "/");
switch(s.getAttribute("id")) { document.querySelector("main").querySelectorAll("article[data-status=deprecated]").forEach((a) => {
a.classList[( s.getAttribute("aria-checked") == "true" ? "add" : "remove" )]("show-deprecated")
case "deprecated" : });
core.cookie.set("show-deprecated", s.getAttribute("aria-checked"), 30, "/");
document.querySelector("main").querySelectorAll("article[data-status=deprecated]").forEach((a) => {
a.classList[( s.getAttribute("aria-checked") == "true" ? "add" : "remove" )]("show-deprecated");
});
break;
case "breakpoints" :
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 // create a pure JS mouse click event
@ -54,24 +42,15 @@ const click = new MouseEvent('click', {
}); });
// get the switch, initialize it and add the handler // get the switch, initialize it and add the handler
let switches = document.querySelector(".info-switches");
swtch.init(switches);
let deprecated = document.querySelector("#deprecated"); let deprecated = document.querySelector("#deprecated");
let breakpoints = document.querySelector("#breakpoints"); swtch.init(deprecated.parentNode)
deprecated.onclick = flipDeprecated;
deprecated.onclick = flipInfoSwitch; deprecated.keypress = flipDeprecated;
deprecated.keypress = flipInfoSwitch;
breakpoints.onclick = flipInfoSwitch;
breakpoints.keypress = flipInfoSwitch;
// check a cookie to get the switch's state // check a cookie to get the switch's state
if (core.cookie.get("show-deprecated") == "true") { if (core.cookie.get("show-deprecated") == "true") {
deprecated.dispatchEvent(click); deprecated.dispatchEvent(click);
} }
if (core.cookie.get("show-breakpoints") == "true") {
breakpoints.dispatchEvent(click);
}
// just for fun... We'll show deprecated if they match the path // just for fun... We'll show deprecated if they match the path
// document.querySelector(`#${core.url.p.replace(/\//g, "-")}`).classList.add("show-deprecated"); // document.querySelector(`#${core.url.p.replace(/\//g, "-")}`).classList.add("show-deprecated");

10
src/pg/_config.pug
View File

@ -27,12 +27,12 @@
}, },
{ {
name: "switch", name: "switch",
status: "complete", status: "in-progress",
core: true, core: true,
}, },
{ {
name: "tooltip", name: "tooltip",
status: "complete", status: "in-progress",
core: true, core: true,
}, },
] ]
@ -45,17 +45,17 @@
files: [ files: [
{ {
name: "header", name: "header",
status: "complete", status: "in-progress",
core: true, core: true,
}, },
{ {
name: "breakpoints", name: "breakpoints",
status: "complete", status: "in-progress",
core: true, core: true,
}, },
{ {
name: "tabs", name: "tabs",
status: "complete", status: "in-progress",
core: true, core: true,
}, },
] ]

15
src/pg/core/_colour-samples.pug
View File

@ -128,27 +128,24 @@
- function generateCSS(c, p) { - function generateCSS(c, p) {
- let o = ""; - let o = "";
- for (let i = 0; i < c.length; i++) { - 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++) { - 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++) { - 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
- var colortxt = "color"
mixin accessibility-info(c) mixin accessibility-info(c)
div.acchb div.acchb
span #{colortxt} & black span color & black
small= getContrastRatio(color(c, "rgb"), "rgb(0,0,0)") + ":1" small= getContrastRatio(color(c, "rgb"), "rgb(0,0,0)") + ":1"
div.acchw div.acchw
span #{colortxt} & white span color & white
small= getContrastRatio(color(c, "rgb"), "rgb(255,255,255)") + ":1" small= getContrastRatio(color(c, "rgb"), "rgb(255,255,255)") + ":1"
div.aa WCAG 2.0 AA div.aa WCAG 2.0 AA
div.accbaa.result div.accbaa.result

179
src/pg/core/_master-index.pug
View File

@ -1,86 +1,93 @@
//- //-
DS2 core (c) 2024 Alexander McIlwraith DS2 core (c) 2024 Alexander McIlwraith
Core licensed under CC BY-SA 4.0 Core licensed under CC BY-SA 4.0
- const getDate = function(){ - const getDate = function(){
- var d = new Date(); - var d = new Date();
- return d.toLocaleDateString(lang, {day: "numeric", month: "long", year: "numeric"}); - return d.toLocaleDateString(lang, {day: "numeric", month: "long", year: "numeric"});
- } - }
- String.prototype.toTitleCase = function() { - String.prototype.toTitleCase = function() {
- return this.replace(/\w\S*/g, function(txt) { - return this.replace(/\w\S*/g, function(txt) {
- return txt.charAt(0).toUpperCase() + txt.substr(1).toLowerCase(); - return txt.charAt(0).toUpperCase() + txt.substr(1).toLowerCase();
- }); - });
- } - }
- String.prototype.toSentenceCase = function() { - String.prototype.toSentenceCase = function() {
- return this.charAt(0).toUpperCase() + this.substr(1).toLowerCase(); - return this.charAt(0).toUpperCase() + this.substr(1).toLowerCase();
- } - }
- String.prototype.toContent = function() { - String.prototype.toContent = function() {
- return this.replace(/-/g, " "); - return this.replace(/-/g, " ");
- } - }
- String.prototype.toPath = function() { - String.prototype.toPath = function() {
- return this.trim().replace(/ /g, "_").replace(/-/g, "_").replace(/[\/\W]/g, "").replace(/_/g, "-"); - return this.trim().replace(/ /g, "_").replace(/-/g, "_").replace(/[\/\W]/g, "").replace(/_/g, "-");
- } - }
include ../_config include ../_config
block config block config
mixin show-content(items, path) mixin show-content(items, path)
- path = (path == "" ? "" : path + "/") + items.name.toPath() - path = (path == "" ? "" : path + "/") + items.name.toPath()
if items.core == true article(id=path.replace(/\//g, "-").toPath()
- items.status = "complete" data-name=items.name
data-status=items.status
article(id=path.replace(/\//g, "-").toPath() data-display=items.display
data-name=items.name data-template=(items.template == undefined ? "pug" : items.template)
data-status=items.status data-core= (items.core ? "true" : "false")
data-display=items.display data-path=path
data-template=(items.template == undefined ? "pug" : items.template) )
data-core= (items.core ? "true" : "false")
data-path=path h1(class="status-" + items.status )
style="height: 100vh" span= items.name.toSentenceCase().toContent()
) tool-tip(role="tooltip" inert tip-position="right")= items.status.toSentenceCase().toContent()
if items.display if items.files
h1(class="status-" + items.status ) each item in items.files
span= items.display +show-content(item, path)
tool-tip(role="tooltip" inert tip-position="right")= items.status.toSentenceCase().toContent()
else
h1(class="status-" + items.status ) doctype html
span= items.name.toSentenceCase().toContent() html(lang= lang )
tool-tip(role="tooltip" inert tip-position="right")= items.status.toSentenceCase().toContent() head
if items.files meta(charset="utf-8")
each item in items.files meta(http-equiv="X-UA-Compatible" content="IE=edge")
+show-content(item, path) meta(name="viewport" content="width=device-width, initial-scale=1")
title(data-site= site )= site
doctype html
html(lang= lang ) block head
head link( href="assets/scaffolding.css" rel="stylesheet" )
meta(charset="utf-8")
meta(http-equiv="X-UA-Compatible" content="IE=edge") body
meta(name="viewport" content="width=device-width, initial-scale=1") //
DS2 core (c) 2024 Alexander McIlwraith
title(data-site= site )= site Core licensed under CC BY-SA 4.0
block head
link( href="assets/scaffolding.css" rel="stylesheet" ) a.skip(href="#main") Skip to main content
div.container
body
// block header
DS2 core (c) 2024 Alexander McIlwraith
Core licensed under CC BY-SA 4.0 main#main
h1= site
a.skip(href="#main") Skip to main content each category in content
div.container +show-content(category, "")
block header script(src="assets/scaffolding-min.js")
main#main
h1= site
each category in content
+show-content(category, "")
script(src="assets/scaffolding-min.js")

85
src/pg/core/_master-pattern.pug
View File

@ -1,48 +1,39 @@
//- //-
DS2 core (c) 2024 Alexander McIlwraith DS2 core (c) 2024 Alexander McIlwraith
Core licensed under CC BY-SA 4.0 Core licensed under CC BY-SA 4.0
include ../_config include ../_config
block config block config
mixin h(h) mixin h(h)
if headings[h] if headings[h]
if headings[h].indexOf("|") == -1 h2= headings[h]
h2= headings[h]
else - const getDate = function(){
- var cntnt = headings[h].split("|") - var d = new Date();
| <#{cntnt[0]}>#{cntnt[1]}</#{cntnt[0]}> - return d.toLocaleDateString(lang, {day: "numeric", month: "long", year: "numeric"});
- }
- const getDate = function(){ - String.prototype.toTitleCase = function() {
- var d = new Date(); - return this.replace(/\w\S*/g, function(txt) {
- return d.toLocaleDateString(lang, {day: "numeric", month: "long", year: "numeric"}); - return txt.charAt(0).toUpperCase() + txt.substr(1).toLowerCase();
- } - });
- String.prototype.toTitleCase = function() { - }
- return this.replace(/\w\S*/g, function(txt) { - String.prototype.toSentenceCase = function() {
- return txt.charAt(0).toUpperCase() + txt.substr(1).toLowerCase(); - return this.charAt(0).toUpperCase() + this.substr(1).toLowerCase();
- }); - }
- } - String.prototype.toContent = function() {
- String.prototype.toSentenceCase = function() { - return this.replace(/-/g, " ");
- return this.charAt(0).toUpperCase() + this.substr(1).toLowerCase(); - }
- } - String.prototype.toPath = function() {
- String.prototype.toContent = function() { - return this.trim().replace(/ /g, "_").replace(/-/g, "_").replace(/[\/\W]/g, "").replace(/_/g, "-");
- return this.replace(/-/g, " "); - }
- }
- String.prototype.toPath = function() {
- return this.trim().replace(/ /g, "_").replace(/-/g, "_").replace(/[\/\W]/g, "").replace(/_/g, "-"); html
- } head
title Pattern
html
head body(data-assetpath= assetpath data-prismjs-copy-timeout="1500")
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")
block content block content

7
src/pg/core/core.scss.pug
View File

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

7
src/pg/index.pug
View File

@ -16,10 +16,7 @@ block header
li(class= navClass) li(class= navClass)
a(href="./?p=" + first.name.toPath() )= first.name.toContent().toSentenceCase() a(href="./?p=" + first.name.toPath() )= first.name.toContent().toSentenceCase()
p.info-switches p.deprecated-switch
span span
span#deprecated(role="switch") span#deprecated(role="switch")
label(for="deprecated") Show deprecated patterns label(for="deprecated") Show deprecated patterns
span
span#breakpoints(role="switch")
label(for="breakpoints") Show breakpoint information

4
src/pg/patterns/core/breakpoints/_breakpoints.scss
View File

@ -1,8 +1,7 @@
//- DS2 core (c) 2024 Alexander McIlwraith //- DS2 core (c) 2024 Alexander McIlwraith
//- Licensed under CC BY-SA 4.0 //- Licensed under CC BY-SA 4.0
// default breakpoints match bootstrap 5 breakpoints. $grid-breakpoints: ( xs: 0, sm: 576px, md: 768px, lg: 992px, xl: 1200px ) !default;
$grid-breakpoints: ( xs: 0, sm: 576px, md: 768px, lg: 992px, xl: 1200px, xxl: 1400px ) !default;
@mixin breakpoint-debug { @mixin breakpoint-debug {
body::before, body::after { body::before, body::after {
@ -10,7 +9,6 @@ $grid-breakpoints: ( xs: 0, sm: 576px, md: 768px, lg: 992px, xl: 1200px, xxl: 14
color: white; color: white;
content: "bigger than extra large"; content: "bigger than extra large";
display: grid; display: grid;
font-family: sans-serif;
font-size: 25px; font-size: 25px;
grid-template-columns: auto; grid-template-columns: auto;
padding: 25px; padding: 25px;

21
src/pg/patterns/core/breakpoints/index.pug
View File

@ -5,26 +5,11 @@ extends ../../../core/_master-pattern
block content block content
+h(0) +h(0)
p Breakpoints enable responsive mobile design.
+h(1) +h(1)
p Use breakpoints when designing for different screen sizes.
p The breakpoints SCSS mixin included implements media queries to allow for the change of the layout and design based on pre-defined screen sizes.
+h(2) +h(2)
p This pattern is only available for SCSS breakpoints. The mixin is avai
p When using this, use the default break points as they are set to the same as the Bootstrap framework. The grid for the design system at large break point has been widened to accompdate 3 colour cards across. p When using this, use the default break points as they are set to the same as the Bootstrap framework. The grid for the design system at large break point has been widened to accompdate 3 colour cards across.
tabset#breakpoints div.tab-group#breakpoints
div(tab="scss") pre.language-css(data-tab="scss")
+h(3) include _breakpoints.scss
pre.language-sass.
@import "scss/core/breakpoints/breakpoints";
@include break([breakpoint]) {
// css here
}
+h(4)
pre.language-sass
include _breakpoints.scss

16
src/pg/patterns/core/header/_header.pp
View File

@ -1,16 +0,0 @@
//- DS2 core (c) 2024 Alexander McIlwraith
//- Licensed under CC BY-SA 4.0
//- required variables
//- site - the site name that goes in the site title
//- root - the path to the root of the site
header
// The headline banner area
svg(height='5.5rem' width='100%' xmlns='http://www.w3.org/2000/svg' aria-hidden='true')
text= site
div
div.header-title
h1
a(href="./")= site
// Other sections can go here, such as search and directory

54
src/pg/patterns/core/header/header.css
View File

@ -1 +1,53 @@
header{display:-ms-grid;display:grid;-ms-grid-rows:1.75rem 3.5rem;grid-template-rows:1.75rem 3.5rem;-ms-grid-column:2;-ms-grid-column-span:2;grid-column:2/4;overflow:hidden}header svg{grid-column:1/-1;grid-row:1/-1;-ms-grid-row-align:stretch;-ms-grid-column-align:stretch;place-self:stretch}header svg text{-webkit-transform:translate(-1rem,7.25rem);-ms-transform:translate(-1rem,7.25rem);transform:translate(-1rem,7.25rem);font-size:10rem;font-weight:1000;font-family:sans-serif;fill:var(--colour-grey-xxl)}header>div{-ms-grid-row:2;grid-row:2;grid-column:1/-1;display:-ms-grid;display:grid;grid-column-gap:1rem;-ms-grid-columns:auto -webkit-max-content -webkit-max-content;-ms-grid-columns:auto max-content max-content;grid-template-columns:auto -webkit-max-content -webkit-max-content;grid-template-columns:auto max-content max-content}header>div .header-title h1{margin:0;padding:0 1rem}header>div .header-title h1 a,header>div .header-title h1 a:visited{border-bottom:none;color:var(--colour-black);font-family:sans-serif;font-size:2.5rem;font-size:32px;font-weight:700;margin:0;padding:0;text-decoration:none} header {
display: -ms-grid;
display: grid;
-ms-grid-rows: 1.75rem 3.5rem;
grid-template-rows: 1.75rem 3.5rem;
-ms-grid-column: 2;
-ms-grid-column-span: 2;
grid-column: 2/4;
overflow: hidden;
}
header svg {
grid-column: 1/-1;
grid-row: 1/-1;
-ms-grid-row-align: stretch;
-ms-grid-column-align: stretch;
place-self: stretch;
}
header svg text {
-webkit-transform: translate(-1rem, 7.25rem);
-ms-transform: translate(-1rem, 7.25rem);
transform: translate(-1rem, 7.25rem);
font-size: 10rem;
font-weight: 1000;
font-family: sans-serif;
fill: var(--colour-grey-xxl);
}
header > div {
-ms-grid-row: 2;
grid-row: 2;
grid-column: 1/-1;
display: -ms-grid;
display: grid;
grid-column-gap: 1rem;
-ms-grid-columns: auto -webkit-max-content -webkit-max-content;
-ms-grid-columns: auto max-content max-content;
grid-template-columns: auto -webkit-max-content -webkit-max-content;
grid-template-columns: auto max-content max-content;
}
header > div .header-title h1 {
margin: 0;
padding: 0 1rem;
}
header > div .header-title h1 a, header > div .header-title h1 a:visited {
border-bottom: none;
color: var(--colour-black);
font-family: sans-serif;
font-size: 2.5rem;
font-size: 32px;
font-weight: 700;
margin: 0;
padding: 0;
text-decoration: none;
}

22
src/pg/patterns/core/header/index.pug
View File

@ -5,15 +5,11 @@ extends ../../../core/_master-pattern
block content block content
+h(0) +h(0)
p A header is layout pattern that helps the user identify the site.
+h(1) +h(1)
p Use a header at the top of every page. The 'front page' of a site may have a different header than the rest of the pages.
+h(2) +h(2)
p Place the header at the top of the page after the skip to main content link. You will likely want to replace core header should be replaced with your own site's header. To do this, remove the #[code.inline.language-js core: true ] and create your own pattern in the location you wish it in your design system.
tabset#header div.tab-group#header
pre.language-html(tab="html") pre.language-html(data-tab="html")
// create temp variables and store the design system values // create temp variables and store the design system values
- var tmpsite= site - var tmpsite= site
- var tmproot= root - var tmproot= root
@ -25,14 +21,8 @@ block content
//- reset variables to original values //- reset variables to original values
- site= tmpsite - site= tmpsite
- root= tmproot - root= tmproot
pre.language-pug(tab="pug")
include _header.pp
pre.language-css(tab="css")
include header.css
div.language-sass(tab="scss")
pre.language-sass.
@import "scss/core/header/header;
pre.language-sass pre.language-sass(data-tab="scss")
include _header.scss include _header.scss
pre.language-css(data-tab="css")
include header.css

10
src/pg/patterns/core/status/index.pug
View File

@ -6,23 +6,23 @@ block content
- -
- let list = [] - let list = []
- for(let i = 0; i < content.length; i++) { - for(let i = 0; i < content.length; i++) {
- list.push({ "name": content[i].name, "path": content[i].name, "status": content[i].status, "display": (content[i].hasOwnProperty("display") && content[i].display != "" ? content[i].display : content[i].name.toSentenceCase().toContent()) } ) - list.push({ "name": content[i].name, "path": content[i].name, "status": content[i].status, "display": content[i].display } )
- if (content[i].files != undefined) { - if (content[i].files != undefined) {
- for (let ii = 0; ii < content[i].files.length; ii++) { - for (let ii = 0; ii < content[i].files.length; ii++) {
- list.push({ "name": content[i].files[ii].name, "path": content[i].name +"."+ content[i].files[ii].name, "status": content[i].files[ii].status, "display": (content[i].files[ii].hasOwnProperty("display") && content[i].files[ii].display != "" ? content[i].files[ii].display : content[i].files[ii].name.toSentenceCase().toContent()) } ) - list.push({ "name": content[i].files[ii].name, "path": content[i].name +"."+ content[i].files[ii].name, "status": content[i].files[ii].status } )
- if (content[i].files[ii].files != undefined) { - if (content[i].files[ii].files != undefined) {
- for (let iii = 0; iii < content[i].files[ii].files.length; iii++) { - for (let iii = 0; iii < content[i].files[ii].files.length; iii++) {
- list.push({ "name": content[i].files[ii].files[iii].name, "path": content[i].name +"."+ content[i].files[ii].name + "." + content[i].files[ii].files[iii].name, "status": content[i].files[ii].files[iii].status, "display": (content[i].files[ii].files[iii].hasOwnProperty("display") && content[i].files[ii].files[iii].display != "" ? content[i].files[ii].files[iii].display : content[i].files[ii].files[iii].name.toSentenceCase().toContent()) } ) - list.push({ "name": content[i].files[ii].files[iii].name, "path": content[i].name +"."+ content[i].files[ii].name + "." + content[i].files[ii].files[iii].name, "status": content[i].files[ii].files[iii].status } )
- } - }
- } - }
- } - }
- } - }
- } - }
- list.sort((a, b) => { - list.sort((a, b) => {
- if (a.display < b.display) { - if (a.name < b.name) {
- return -1; - return -1;
- } - }
- if (a.display > b.display) { - if (a.name > b.name) {
- return 1; - return 1;
- } - }
- return 0; - return 0;

2
src/pg/patterns/core/sticky-note/_sticky-note.pp
View File

@ -1,2 +0,0 @@
sticky-note(float="right").blue This #[strong is] a sample sticky.
| You can drag it out of the way if you need to see the content under it.

2
src/pg/patterns/core/sticky-note/_sticky-note.pug
View File

@ -1,2 +0,0 @@
sticky-note(float="right").blue This #[strong is] a sample sticky.
| You can drag it out of the way if you need to see the content under it.

38
src/pg/patterns/core/sticky-note/index.pug
View File

@ -8,36 +8,24 @@ block content
+h(1) +h(1)
p Use a sticky when you want to make a note without adding it to the content. p Use a sticky when you want to make a note without adding it to the content.
+h(2) +h(2)
p Uses absolute positioning. Passing an optional element to the init function will initialise tabs within that element. You can move the position using either #[code.language-html.inline float="&#91; right | left &#93;"] or #[code.language-html.inline offset="&#91; top | left &#93;"]. Offset will take negative values in any web measurement unit. p Uses absolute positioning.
sticky-note.blue(offset="-10rem 1rem") This #[strong is] a sample sticky. You can drag it out of the way if you need to see the content under it. sticky-note(float="right").blue This #[strong is] a sample sticky.
sticky-note(float="right") You will notice when you hover over the sticky, it shows a dot in the colour of the sticky in the position where the sticky note refers to (assuming you haven't dragged it and scrolled that location off the screen). | You can drag it out of the way if you need to see the content under it.
p If you wish to create a custom element, that extends another HTML element, the native element has to be extended in customElements.define(). Custom elements that inherit native elements are also known as "type extension custom elements". p If you wish to create a custom element, that extends another HTML element, the native element has to be extended in customElements.define(). Custom elements that inherit native elements are also known as "type extension custom elements".
sticky-note You will notice when you hover over the sticky, it shows a dot in the colour of the sticky in the position where the sticky note refers to (assuming you haven't dragged it and scrolled that location off the screen).
tabset#sticky-note tabset#sticky-note
pre.language-html(tab="html") pre.language-html(tab="html")
include _sticky-note.pug sticky-note(float="right").blue This #[strong is] a sample sticky.
pre.language-pug(tab="pug") | You can drag it out of the way if you need to see the content under it.
include _sticky-note.pp pre.language-pug(tab="pug").
sticky-note(float="right").blue This #[strong is] a sample sticky.
| You can drag it out of the way if you need to see the content under it.
pre.language-css(data-tab="css") pre.language-css(data-tab="css")
include sticky-note.css include sticky-note.css
div(tab="scss") pre.language-css(data-tab="scss")
+h(3) include _sticky-note.scss
pre.language-sass. pre.language-js(data-tab="js")
$sticky-colors: ( [sass map with your own defined colours] ); include _sticky-note.js
@import "scss/core/switch/_sticky-note";
@include sticky-note;
+h(4)
pre.language-sass
include _sticky-note.scss
div(tab="js")
+h(3)
pre.language-js.
import * as stickynote from ""./js/core/sticky-note/_sticky-note.js";
stickynote.init()
+h(4)
pre.language-js
include _sticky-note.js

127
src/pg/patterns/core/sticky-note/sticky-note.css
View File

@ -1 +1,126 @@
@import url("https://fonts.googleapis.com/css2?family=Kalam:wght@300;400;700&display=swap");sticky-note-wrapper{-webkit-box-sizing:border-box;box-sizing:border-box;border:1px solid transparent;border-radius:50%;display:inline-block;height:0.5rem;position:relative;width:0.5rem}sticky-note-wrapper *{-webkit-box-sizing:border-box;box-sizing:border-box}sticky-note-wrapper sticky-note{cursor:-webkit-grab;cursor:grab;display:-ms-grid;display:grid;float:left;font-size:1rem;height:13rem;left:0;place-items:stretch;position:absolute;top:0;width:13rem;z-index:100}sticky-note-wrapper sticky-note:active{cursor:-webkit-grabbing;cursor:grabbing;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}sticky-note-wrapper sticky-note.right{float:right}sticky-note-wrapper sticky-note>div{-ms-grid-row:1;grid-row:1;-ms-grid-column:1;grid-column:1}sticky-note-wrapper sticky-note>div:first-child{background-color:rgba(0,0,0,0.25);-webkit-box-shadow:-2px 2px 15px 0 rgba(0,0,0,0.5);box-shadow:-2px 2px 15px 0 rgba(0,0,0,0.5);display:-ms-grid;display:grid;margin:2rem 1rem 0.25rem 0.36rem;width:calc(100% - 1rem)}sticky-note-wrapper sticky-note>div:nth-child(2){clip-path:url(#stickyClip);display:-ms-grid;display:grid;font-family:"Kalam",cursive;font-style:1rem;font-weight:300;line-height:1.25rem;padding:1rem;place-items:center;text-align:center}sticky-note-wrapper sticky-note>div:nth-child(2)>*{font-family:"Kalam",cursive!important;font-style:normal!important;font-weight:300!important}@media screen and (max-width:1024px){sticky-note-wrapper sticky-note>div:nth-child(2){max-width:13rem;min-width:13rem;width:1rem}}@media screen and (max-width:768px){sticky-note-wrapper sticky-note>div:nth-child(2){font-size:1.75rem;max-width:21rem;min-height:21rem}}@media screen and (max-width:640px){sticky-note-wrapper sticky-note>div:nth-child(2){font-size:2.5rem;max-width:26rem;min-height:26rem}}sticky-note-wrapper sticky-note>div:nth-child(2){background:-webkit-gradient(linear,left top,left bottom,from(#ffffdd),color-stop(2%,#ffffd3),color-stop(12%,#ffffd3),color-stop(75%,#ffffc9),to(#ffffba));background:linear-gradient(180deg,#ffffdd 0%,#ffffd3 2%,#ffffd3 12%,#ffffc9 75%,#ffffba 100%)}sticky-note-wrapper sticky-note.blue>div:nth-child(2){background:-webkit-gradient(linear,left top,left bottom,from(#9dddec),color-stop(2%,#94daea),color-stop(12%,#94daea),color-stop(75%,#8bd7e8),to(#7fd3e6));background:linear-gradient(180deg,#9dddec 0%,#94daea 2%,#94daea 12%,#8bd7e8 75%,#7fd3e6 100%)}sticky-note-wrapper sticky-note.pink>div:nth-child(2){background:-webkit-gradient(linear,left top,left bottom,from(#fa7c93),color-stop(2%,#fa728b),color-stop(12%,#fa728b),color-stop(75%,#fa6883),to(#f95977));background:linear-gradient(180deg,#fa7c93 0%,#fa728b 2%,#fa728b 12%,#fa6883 75%,#f95977 100%)}sticky-note-wrapper sticky-note.green>div:nth-child(2){background:-webkit-gradient(linear,left top,left bottom,from(#c5fcc9),color-stop(2%,#bbfbc0),color-stop(12%,#bbfbc0),color-stop(75%,#b1fab7),to(#a3faaa));background:linear-gradient(180deg,#c5fcc9 0%,#bbfbc0 2%,#bbfbc0 12%,#b1fab7 75%,#a3faaa 100%)}sticky-note-wrapper:has(sticky-note:hover){background-color:#ffffd3;border:1px solid black}sticky-note-wrapper:has(sticky-note.yellow:hover){background-color:#ffffd3}sticky-note-wrapper:has(sticky-note.blue:hover){background-color:#94daea}sticky-note-wrapper:has(sticky-note.pink:hover){background-color:#fa728b}sticky-note-wrapper:has(sticky-note.green:hover){background-color:#bbfbc0} @import url("https://fonts.googleapis.com/css2?family=Kalam:wght@300;400;700&display=swap");
sticky-note-wrapper {
-webkit-box-sizing: border-box;
box-sizing: border-box;
border: 1px solid transparent;
border-radius: 50%;
display: inline-block;
height: 0.5rem;
position: relative;
width: 0.5rem;
}
sticky-note-wrapper * {
-webkit-box-sizing: border-box;
box-sizing: border-box;
}
sticky-note-wrapper sticky-note {
cursor: -webkit-grab;
cursor: grab;
display: -ms-grid;
display: grid;
float: left;
font-size: 1rem;
height: 13rem;
left: 0;
place-items: stretch;
position: absolute;
top: 0;
width: 13rem;
z-index: 100;
}
sticky-note-wrapper sticky-note:active {
cursor: -webkit-grabbing;
cursor: grabbing;
-webkit-user-select: none;
-moz-user-select: none;
-ms-user-select: none;
user-select: none;
}
sticky-note-wrapper sticky-note.right {
float: right;
}
sticky-note-wrapper sticky-note > div {
-ms-grid-row: 1;
grid-row: 1;
-ms-grid-column: 1;
grid-column: 1;
}
sticky-note-wrapper sticky-note > div:nth-child(1) {
background-color: rgba(0, 0, 0, 0.25);
-webkit-box-shadow: -2px 2px 15px 0 rgba(0, 0, 0, 0.5);
box-shadow: -2px 2px 15px 0 rgba(0, 0, 0, 0.5);
display: -ms-grid;
display: grid;
margin: 2rem 1rem 0.25rem 0.36rem;
width: calc(100% - 1rem);
}
sticky-note-wrapper sticky-note > div:nth-child(2) {
clip-path: url(#stickyClip);
display: -ms-grid;
display: grid;
font-family: "Kalam", cursive;
font-style: 1rem;
font-weight: 300;
line-height: 1.25rem;
padding: 1rem;
place-items: center;
text-align: center;
}
sticky-note-wrapper sticky-note > div:nth-child(2) > * {
font-family: "Kalam", cursive !important;
font-style: normal !important;
font-weight: 300 !important;
}
@media screen and (max-width: 1024px) {
sticky-note-wrapper sticky-note > div:nth-child(2) {
max-width: 13rem;
min-width: 13rem;
width: 1rem;
}
}
@media screen and (max-width: 768px) {
sticky-note-wrapper sticky-note > div:nth-child(2) {
font-size: 1.75rem;
max-width: 21rem;
min-height: 21rem;
}
}
@media screen and (max-width: 640px) {
sticky-note-wrapper sticky-note > div:nth-child(2) {
font-size: 2.5rem;
max-width: 26rem;
min-height: 26rem;
}
}
sticky-note-wrapper sticky-note > div:nth-child(2) {
background: -webkit-gradient(linear, left top, left bottom, from(#ffffdd), color-stop(2%, #ffffd3), color-stop(12%, #ffffd3), color-stop(75%, #ffffc9), to(#ffffba));
background: linear-gradient(180deg, #ffffdd 0%, #ffffd3 2%, #ffffd3 12%, #ffffc9 75%, #ffffba 100%);
}
sticky-note-wrapper sticky-note.blue > div:nth-child(2) {
background: -webkit-gradient(linear, left top, left bottom, from(#9dddec), color-stop(2%, #94daea), color-stop(12%, #94daea), color-stop(75%, #8bd7e8), to(#7fd3e6));
background: linear-gradient(180deg, #9dddec 0%, #94daea 2%, #94daea 12%, #8bd7e8 75%, #7fd3e6 100%);
}
sticky-note-wrapper sticky-note.pink > div:nth-child(2) {
background: -webkit-gradient(linear, left top, left bottom, from(#fa7c93), color-stop(2%, #fa728b), color-stop(12%, #fa728b), color-stop(75%, #fa6883), to(#f95977));
background: linear-gradient(180deg, #fa7c93 0%, #fa728b 2%, #fa728b 12%, #fa6883 75%, #f95977 100%);
}
sticky-note-wrapper sticky-note.green > div:nth-child(2) {
background: -webkit-gradient(linear, left top, left bottom, from(#c5fcc9), color-stop(2%, #bbfbc0), color-stop(12%, #bbfbc0), color-stop(75%, #b1fab7), to(#a3faaa));
background: linear-gradient(180deg, #c5fcc9 0%, #bbfbc0 2%, #bbfbc0 12%, #b1fab7 75%, #a3faaa 100%);
}
sticky-note-wrapper:has(sticky-note:hover) {
background-color: #ffffd3;
border: 1px solid black;
}
sticky-note-wrapper:has(sticky-note.yellow:hover) {
background-color: #ffffd3;
}
sticky-note-wrapper:has(sticky-note.blue:hover) {
background-color: #94daea;
}
sticky-note-wrapper:has(sticky-note.pink:hover) {
background-color: #fa728b;
}
sticky-note-wrapper:has(sticky-note.green:hover) {
background-color: #bbfbc0;
}

18
src/pg/patterns/core/switch/_switch.js
View File

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

1
src/pg/patterns/core/switch/_switch.pp
View File

@ -1 +0,0 @@
span#example-id(role="switch")

41
src/pg/patterns/core/switch/index.pug
View File

@ -5,44 +5,23 @@ extends ../../../core/_master-pattern
block content block content
+h(0) +h(0)
p Switches are used to toggle application state between two mutually exclusive values. p Switches are used to toggle application state between two mutually exlusive values.
+h(1) +h(1)
p Use a switch when the user will see an immediate visible state change. Do not use a switch when the state change will affect future results. The user should not have to perform another action (search, save, etc) for the result to take affect. If the change in state does not take effect immediately, consider a checkbox.
+h(2) +h(2)
p The switch label should describe what will happen when the switch is turned to the on state. Frontload labels with keywords.
p Include the CSS and JavaScript. An additional handler will need to be created for the actual state change. The CSS implements the visual design of the switch, which is based on the accessibility properties, which are implemented by the JavaScript.
h2 Example h2 Example
p.switch p.switch
label(for="example-switch") Switch label (states the on state) label(for="example-switch") Switch label
span#example-switch(role="switch") span#example-switch(role="switch")
div#switches.tab-group div#switches.tab-group
pre.language-html(tab="html") pre.language-html(data-tab="html")
include _switch.pug include _switch.pug
pre.language-pug(tab="pug") pre.language-pug(data-tab="pug")
include _switch.pp include switch.pug
pre.language-css(tab="css") pre.language-css(data-tab="css")
include switch.css include switch.css
div(tab="scss") pre.language-css(data-tab="scss")
+h(3) include _switch.scss
pre.language-sass. pre.language-js(data-tab="js")
@import "scss/core/switch/_switch"; include _switch.js
@include switch;
+h(4)
pre.language-sass
include _switch.scss
div(tab="js")
+h(3)
pre.language-js.
// Note that switch is a reserved word.
import * as swtch from "./js/core/switch/_switch.js";
swtch.init();
+h(4)
pre.language-js
include _switch.js

27
src/pg/patterns/core/switch/switch.css
View File

@ -1 +1,26 @@
[role=switch]{display:-ms-inline-grid;display:inline-grid;border:1px solid #2e51a1;background-color:#d8d8d8;border-radius:0.75rem;height:1.5rem;width:3rem;-webkit-transition:all 500ms;transition:all 500ms}[role=switch]>span{display:inline-block;background-color:white;border-radius:50%;margin:2%;width:calc(1.5rem - 2%);-webkit-transition:all 500ms;transition:all 500ms}[role=switch][aria-checked=true]{background-color:#2e51a1}[role=switch][aria-checked=true]>span{margin-left:calc(1.5rem - 5%)} [role=switch] {
display: -ms-inline-grid;
display: inline-grid;
border: 1px solid var(--colour-blue);
background-color: var(--colour-grey-xl);
border-radius: 0.75rem;
height: 1.5rem;
width: 3rem;
-webkit-transition: all 500ms;
transition: all 500ms;
}
[role=switch] > span {
display: inline-block;
background-color: white;
border-radius: 50%;
margin: 2%;
width: calc(1.5rem - 2%);
-webkit-transition: all 500ms;
transition: all 500ms;
}
[role=switch][aria-checked=true] {
background-color: var(--colour-blue);
}
[role=switch][aria-checked=true] > span {
margin-left: calc(1.5rem - 5%);
}

2
src/pg/patterns/core/switch/switch.pug Normal file
View File

@ -0,0 +1,2 @@
.
span#example-id(role="switch")

82
src/pg/patterns/core/tabs/_tabs.js
View File

@ -1,39 +1,10 @@
/* DS2 core (c) 2024 Alexander McIlwraith /* DS2 core (c) 2024 Alexander McIlwraith
Released under Creative Commons Attribution-ShareAlike 4.0 International import * as tabs from "../pg/patterns/layouts/tabs/_tabs.js";
tabs.init();
*/ */
// create a pure JS mouse click event export function init(p = document) {
const click = new MouseEvent('click', { p.querySelectorAll(".tab-group, tabset").forEach(tabGroup => {
view: window,
bubbles: false,
cancelable: true
});
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) { if (tabGroup.querySelector("[role=tablist]") === null) {
const tabgroup = tabGroup.getAttribute("id"); const tabgroup = tabGroup.getAttribute("id");
@ -59,47 +30,24 @@ export function init(container = document, spacer = true, args = {}) {
const ul = document.createElement('ul'); const ul = document.createElement('ul');
ul.setAttribute("role", "tablist"); ul.setAttribute("role", "tablist");
ul.innerHTML = spacer != true ? `${tablist}` : `${tablist}<li role="separator" class="separator"></li>`; ul.innerHTML = `${tablist}<li role="separator" class="separator"></li>`;
tabGroup.insertBefore(ul, tabGroup.firstChild); tabGroup.insertBefore(ul, tabGroup.firstChild);
tabGroup.querySelectorAll('[role="tab"]').forEach(tab => { tabGroup.querySelectorAll('[role="tab"]').forEach(tab => {
tab.addEventListener("click", (e) => { tab.addEventListener("click", () => {
if (e.altKey && typeof args.altModifier == "function") { const siblings = Array.from(tab.parentNode.children);
args.altModifier(tab); siblings.forEach(sibling => sibling.classList.remove("selected"));
} else if (e.shiftKey && typeof args.shiftModifier == "function") { tab.classList.add("selected");
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) const tabPanels = Array.from(tab.parentNode.parentNode.children)
.filter(child => child.getAttribute("role") === "tabpanel"); .filter(child => child.getAttribute("role") === "tabpanel");
tabPanels.forEach(panel => panel.classList.remove("open")); tabPanels.forEach(panel => panel.classList.remove("open"));
const tabPanelId = tab.getAttribute("id").replace("tab", "tab-panel"); const tabPanelId = tab.getAttribute("id").replace("tab", "tab-panel");
document.getElementById(tabPanelId).classList.add("open"); document.getElementById(tabPanelId).classList.add("open");
}
}); });
tab.addEventListener("keypress", (e) => {
e.preventDefault();
if( e.which == 32 || e.which == 13 ) {
e.currentTarget.dispatchEvent(click);
}
})
}); });
}
if (document.location.hash != "" && document.location.hash.substring(0,5) == "#tab-") {
waitForElement(document.location.hash).then((el) => {
el.scrollIntoView();
el.dispatchEvent(click);
});
} }
}); });
} }

4
src/pg/patterns/core/tabs/_tabs.pp
View File

@ -1,4 +0,0 @@
tabset#uniqueID
div(tab="[tab title]")
div(tab="[tab title]")

6
src/pg/patterns/core/tabs/_tabs.pug
View File

@ -1,4 +1,4 @@
tabset#uniqueID div#uniqueID.tab-group
div(tab="[tab title]") div(data-tab="[tab title]")
div(tab="[tab title]") div(data-tab="[tab title]")

43
src/pg/patterns/core/tabs/index.pug
View File

@ -5,9 +5,9 @@ extends ../../../core/_master-pattern
block content block content
+h(0) +h(0)
p A tabs component that provides different sections of content that are displayed one at a time when the user selects that information.
+h(1) +h(1)
+h(2)
p The tabbed user interface enables users to jump to their target section quickly. Tabs present like logically group information on the same page. Information should p The tabbed user interface enables users to jump to their target section quickly. Tabs present like logically group information on the same page. Information should
ul ul
@ -19,43 +19,24 @@ block content
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 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.
+h(2) p The tab module can be initialised by importing a file with the javascript module using import * as tabs from "../pg/patterns/layouts/tabs/_tabs.js"; contains a modularized version of the jQuery code, so that it can be called on demand. It is what is used in the design system so that the JavaScript can be called at run time (after loading content).
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 tabset#tabs
pre.language-html(tab="html") pre.language-html(tab="html")
include _tabs.pug include _tabs.pug
pre.language-pug(tab="pug")
include _tabs.pp //- pre.language-pug(tab="pug").
include _tabs.pug
pre.language-css(tab="css") pre.language-css(tab="css")
include tabs.css include tabs.css
div(tab="scss")
+h(3) pre.language-css(tab="scss")
pre.language-sass. include _tabs.scss
@import "scss/core/tabs/_tabs";
@include tabs{
// optional content block
};
+h(4) pre.language-css(tab="js")
pre.language-sass include _tabs.js
include _tabs.scss
div(tab="js")
+h(3)
pre.language-js.
import * as tabs from "./js/core/tabs/_tabs.js";
tabs.init();
+h(4)
pre.language-js
include _tabs.js

20
src/pg/patterns/core/tabs/tabs.css
View File

@ -9,8 +9,8 @@ tabset > ul, .tab-group > ul {
padding: 0; padding: 0;
} }
tabset > ul li.separator, .tab-group > ul li.separator { tabset > ul li.separator, .tab-group > ul li.separator {
border-bottom: 1px solid #7f7f7f; border-bottom: 1px solid var(--colour-grey);
border-left: 1px solid #7f7f7f; border-left: 1px solid var(--colour-grey);
display: inline-block; display: inline-block;
margin: 0.45rem 0 0 0; margin: 0.45rem 0 0 0;
width: 100%; width: 100%;
@ -19,9 +19,9 @@ tabset .tab-hidden, .tab-group .tab-hidden {
display: none; display: none;
} }
tabset [role=tab], .tab-group [role=tab] { tabset [role=tab], .tab-group [role=tab] {
background-color: #FFF; background-color: var(--colour-white);
border-left: 1px solid #7f7f7f; border-left: 1px solid var(--colour-grey);
border-top: 1px solid #7f7f7f; border-top: 1px solid var(--colour-grey);
border-radius: 0.5rem 0.5rem 0 0; border-radius: 0.5rem 0.5rem 0 0;
cursor: pointer; cursor: pointer;
margin: 0; margin: 0;
@ -30,19 +30,19 @@ tabset [role=tab], .tab-group [role=tab] {
z-index: 2; z-index: 2;
} }
tabset [role=tab]:last-of-type, .tab-group [role=tab]:last-of-type { tabset [role=tab]:last-of-type, .tab-group [role=tab]:last-of-type {
border-right: 1px solid #7f7f7f; border-right: 1px solid var(--colour-grey);
} }
tabset [role=tab]:not(.selected), .tab-group [role=tab]:not(.selected) { tabset [role=tab]:not(.selected), .tab-group [role=tab]:not(.selected) {
background-color: #f0f0f0; background-color: var(--colour-grey-xxl);
border-bottom: 1px solid #7f7f7f; border-bottom: 1px solid var(--colour-grey);
} }
tabset [role=tab] span, .tab-group [role=tab] span { tabset [role=tab] span, .tab-group [role=tab] span {
display: block; display: block;
margin: 0 0 0.5rem 0; margin: 0 0 0.5rem 0;
} }
tabset [role=tabpanel], .tab-group [role=tabpanel] { tabset [role=tabpanel], .tab-group [role=tabpanel] {
background-color: #FFF; background-color: var(--colour-white);
border: 1px solid #7f7f7f; border: 1px solid var(--colour-grey);
border-top: none; border-top: none;
padding: 1rem; padding: 1rem;
z-index: 1; z-index: 1;

2
src/pg/patterns/core/tooltip/_tooltip.pp
View File

@ -1,2 +0,0 @@
a(href="#") Link with a tool tip
span(role="tooltip" inert tip-position="right") Tool tip content

5
src/pg/patterns/core/tooltip/_tooltip.pug
View File

@ -1,2 +1,5 @@
a(href="#") Link with a tool tip a(href="#") Link with a tool tip
span(role="tooltip" inert tip-position="right") Tool tip content div(role="tooltip" inert tip-position="bottom") Tool tip content
a(href="#") Link with a tool tip
tool-tip(role="tooltip" inert tip-position="bottom") Tool tip content

2
src/pg/patterns/core/tooltip/_tooltip.scss
View File

@ -1,7 +1,6 @@
//- DS2 core (c) 2024 Alexander McIlwraith //- DS2 core (c) 2024 Alexander McIlwraith
//- Licensed under CC BY-SA 4.0 //- Licensed under CC BY-SA 4.0
$font-body: sans-serif !default;
$tooltip-border-radius: .5rem !default; $tooltip-border-radius: .5rem !default;
$tooltip-dark-allow: true !default; $tooltip-dark-allow: true !default;
$tooltip-dark-background: #1f2127 !default; $tooltip-dark-background: #1f2127 !default;
@ -30,7 +29,6 @@ $tooltip-pointer-top: conic-gradient(from 150deg at top, rgba(0, 0, 0, 0), #000
border-radius: $tooltip-border-radius; border-radius: $tooltip-border-radius;
color: $tooltip-light-foreground; color: $tooltip-light-foreground;
filter: $tooltip-light-drop-shadow; filter: $tooltip-light-drop-shadow;
$font-family: $font-body;
font-size: 1rem; font-size: 1rem;
font-weight: 400; font-weight: 400;
inline-size: max-content; inline-size: max-content;

34
src/pg/patterns/core/tooltip/index.pug
View File

@ -5,22 +5,13 @@ extends ../../../core/_master-pattern
block content block content
+h(0) +h(0)
p Tooltips provide brief information messaging through a mouse or keyboard hover.
+h(1) +h(1)
p Use tool tips to provide additional information. Don't use tooltips for that is required to complete an interaction as the information disappears when it loses the hover state.
p Use tooltips to help differentiate between multiple, close, similar options.
+h(2) +h(2)
p.notification-box.info Currently, there is no easy way to activate a hover without with pure CSS without using a keyboard or mouse. Level4 media queries aim to solve that. p Either form works. Place this inside another element for the tooltip to be "linked to that element."
p Either form works.
sticky-note.blue "Either form works": What are the two forms.
| Place the #[code.language-html.inline tooltip] inside another element for the tooltip to be 'linked to that element.' A container element may need to be added for a single tag element, such as a input field.
p Tool tip positions are: p Tool tip positions are:
ul ul
@ -29,23 +20,14 @@ block content
li bottom / block-end li bottom / block-end
li left / inline-start li left / inline-start
p
include _tooltip.pug
div#tooltip.tab-group
tabset#tooltip pre.language-html(data-tab="html")
pre.language-html(tab="html")
include _tooltip.pug include _tooltip.pug
pre.language-pug(tab="pug") pre.language-pug(data-tab="pug")
include _tooltip.pp include tooltip.pug
pre.language-css(tab="css") pre.language-css(data-tab="css")
include tooltip.css include tooltip.css
div(tab="scss") pre.language-css(data-tab="scss")
+h(3) include _tooltip.scss
pre.language-sass.
@import "scss/core/tooltip/_tooltip";
@include tooltip;
+h(4)
pre.language-sass
include _tooltip.scss

6
src/pg/patterns/core/tooltip/tooltip.pug Normal file
View File

@ -0,0 +1,6 @@
.
a(href="#") Link with a tool tip
div(role="tooltip" inert tip-position="bottom") Tool tip content
a(href="#") Link with a tool tip
tool-tip(role="tooltip" inert tip-position="bottom") Tool tip content

7
src/scss/_core.scss
View File

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

12
src/scss/scaffolding.scss
View File

@ -35,9 +35,6 @@ html {
@include break(-md) { @include break(-md) {
font-size: calc($font-size + 2pt); font-size: calc($font-size + 2pt);
} }
&.show-breakpoints {
@include breakpoint-debug;
}
} }
@include core-colour-samples; @include core-colour-samples;
@ -90,18 +87,11 @@ body {
} }
p.info-switches { p.deprecated-switch {
align-items: center;
display: grid;
gap: .25rem;
grid-column: 2 / 4; grid-column: 2 / 4;
grid-row: 3; grid-row: 3;
grid-template-columns: auto repeat(2, max-content);
text-align: right; text-align: right;
@include switch; @include switch;
label {
text-align: left;;
}
} }
main { main {