AndcultureCode.JavaScript.Core

Common patterns, functions, etc... used when building javascript applications

Getting started

This package is installed via npm or yarn

# npm
npm install --save-dev andculturecode-javascript-core

# yarn
yarn add andculturecode-javascript-core --dev

From there you can import the variety of modules.

import { CollectionUtils, CoreUtils } from "andculturecode-javascript-core";

You can also reference the global distribution package within a website which gives you access to the AndcultureCode namespace. See the example below

<script src="https://unpkg.com/browse/andculturecode-javascript-core@[version-number]/dist/global/index.js"></script>

<script>
    var myAuthObject = AndcultureCode.RouteUtils.queryStringToObject(
        "#token=bada55cafe"
    );
</script>

Peer dependencies

This package wraps several external packages for our own configuration and ease of use, such as axios, i18next, lodash, etc. If you are using the standard distribution of this package, these will need to be installed alongside this package, even if you do not plan on leveraging features that rely on them.

If using the global distribution, you will likely want to reference these in your website prior to referencing this package. See test-global-distribution.html for the full list of dependencies. Unlike the standard distribution, peer dependencies are only required if your code will be executing code paths that rely on those packages.

Internationalization

This package offers a variety of functions for localizing an application, wrapping i18next and i18next-browser-languagedetector. A complete setup guide can be found in the wiki here.

If developing in VS Code, the kazoo extension can be used to quickly insert typed keys and placeholder translations from Google Translate. (source | install)

Documentation

Full API documentation

Contributing

Information on contributing to this repo is in the Contributing Guide

Contributors ✨

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!