@gold.au/core
Advanced tools
Readme
The core module all gold.au components modules depend on.
yarn add @gold.au/core
npm install @gold.au/core
Get the contrast ratio of two colors and warn when it is below WCAG 2.0 AA standard 4.5:1
AU-color-contrast( foreground, background, silent, rounded )
The paramaters are:
foreground - Color one
background - Color two
silent - If the logs get printed in the terminal
rounded - If the value is rounded or not
Example:
content: AU-color-contrast( red, blue );
The function to find the nearest accessible color.
AU-color-a11y( toMakeA11y, background, ratioKey, steps )
The paramaters are:
toMakeA11y - The color that is to be changed.
background - The background color to compare against toMakeA11y for the contrast.
ratioKey - The keyword small or large to set the WCAG 2.1 contrast ration or 3.0 or 4.5.
steps - The step size our function is searching for a new color in. The bigger the number the faster the process the rougher the found color. Must be from 0.1 to 100.
Example:
background: AU-color-a11y( red, blue );
Generate an optimized SVG data-uri.
AU-svguri( svg )
The paramaters are:
svg - The SVG data to be converted.
Example:
background-image: AU-svguri('<svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 128 128">
<path fill="red" d="M128 64l-64 64-16-16 64-64"/>
<path fill="red" d="M128 64l-16 16-64-64L64 0"/>
</svg>');
Create media queries and wraps the @content code inside of it.
AU-media( breakpoint )
The paramaters are:
breakpoint - Either one of the following keywords: xs, sm, md, lg
Example:
@include AU-media( sm ) {
width: 48%;
}
Mixin for setting font-size and line-height that snaps to the grid.
AU-fontgrid( fontsize, lineheight )
The paramaters are:
fontsize - Either one of the following keywords: xs, sm, md, lg, xl, xxl, xxxl.
lineheight - Either one of the following keywords: heading, nospace, default.
Example:
@include AU-fontgrid( md, heading );
Mixin for setting a properties value to snap to the grid, with a fallback for REM.
AU-space( property, value )
The paramaters are:
property - The css property to apply the spacing ( padding, margin, border )
value - The values of the property ( 0, 20px, 1unit, 5% )
Example:
@include AU-space( margin, 1unit 10% );
Add the outline to focus.
AU-focus( dark )
The paramaters are:
theme - Either one of the following keywords: light or dark.
Example:
@include AU-focus();
Hide an element from the screen but not a screen reader.
AU-sronly()
Example:
@include AU-sronly();
Clearing floats.
AU-clearfix()
Example:
@include AU-clearfix();
/core
The visual test: https://auds.service.gov.au/packages/core/tests/site/
hint-text and hint-text-alt.--alt backgroundsCopyright (c) Commonwealth of Australia. Licensed under MIT.
FAQs
The core module all components modules depend on
We found that @gold.au/core demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
LDAPjs, an LDAP Client and Server API for Node.js, was decommissioned after its maintainer received an abusive email from a user, raising concerns about this form of abuse as a potential attack vector.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.
Security News
Socket is joining forces with CISA and other industry leaders at the RSA Conference to sign the Secure by Design pledge, committing to uphold the highest security standards in our products.