@aegov/design-system - npm Package Compare versions

Comparing version 0.1.48 to 2.0.0

package.json

		{
		"name": "@aegov/design-system",
		"version": "0.1.48",
		"version": "2.0.0",
		"description": "A design system for the Government of the United Arab Emirates. The design system has been created based on research and information collected from in-depth studies conducted on user behaviour and benchmarking best practices. The primary use of this design system is to allow ministries of the United Arab Emirates to create consistent websites with components that are common and acceissible.",
		@@ -5,0 +5,0 @@ "keywords": [

README.md

		@@ -18,16 +18,65 @@ <div>

		The purpose of the design system is to create a set of components, blocks and patterns with detailed guidelines on how to create web UI for Federal Ministries and Authorities of the United Arab Emirates.
		The purpose of the design system is to create a set of components, blocks and patterns with detailed guidelines on how to create UI for websites and application of Federal Government Entities (FGE's) of the United Arab Emirates. This system is designed primarily for content specialists, user interface (UI) designers, developers, user researchers and digital operations teams of FGE's.

		---

		## Objective

		The system aims to unify the digital presence of FGE's. It seeks to position the UAE as a pioneer in the provision of digital services as measured by the United Nation's Online Services Index and in line with the UAE Government Charter for Future Services.

		---

		## Documentation

		For full documentation, visit [UAE Design Language System](https://dls.government.ae).
		For full documentation, visit [UAE Design System](https://designsystem.gov.ae).

		## Getting started

		The Design Language System is built with standards and components that will help you build websites faster and with a consistent UI adhering to accessibility principles.
		The design system is built with standards and components that will help you build websites faster and with a consistent UI adhering to accessibility principles.

		The Design Language System (DLS) is built with [TailwindCSS](https://tailwindcss.com) and to get started, you simply need to add the the DLS plugin to your existing or new TailwindCSS Project.
		The design system is built with [TailwindCSS](https://tailwindcss.com) and to get started, you simply need to add the the <code>@aegov/design-system</code> plugin to your existing or new TailwindCSS project.

		For installation instructions, go to [dls.government.ae/docs/installation](https://dls.government.ae/docs/installation)
		For installation instructions, go to [designsystem.gov.ae/docs/installation](https://designsystem.gov.ae/docs/installation)

		### How to install the plugin.

		If you want to install the package via the NPM CLI, you can use the following:

		<pre>
		npm install @aegov/design-system
		</pre>

		If you want to add the package to your package.json file, you can use the following:

		<pre>
		...
		{
		"dependencies": {
		"@aegov/design-system": "^2.0"
		}
		}
		...
		</pre>

		## The use of JavaScript

		The design system aims to provide guidelines and components, focusing on the look and feel of each component, block and pattern. To faciliate the easy use of components and blocks, each of them have relevant code example. Developers can use the provided code examples to add components and blocks to their project.

		Some components depend on the use of JavaScript. The design system does not mandate the use of the bundled JavaScript library, however recommend's it's use. The bundled JavaScript is forked from [Flowbite's JS](https://github.com/themesberg/flowbite) library.

		If a developer chooses not to use the bundled JavaScript, it is expected that the functionality and interaction of each component needs to be consistent to what is available on the design system website.

		## What more is available

		The design system also includes:

		- [Guidelines](https://designsystem.gov.ae/guidelines)
		- [Components](https://designsystem.gov.ae/docs/components)
		- [Blocks](https://designsystem.gov.ae/docs/blocks)
		- [Patterns](https://designsystem.gov.ae/docs/patterns)
		- [Assets, tools and templates](https://designsystem.gov.ae/resources/assets-and-tools)
		- [Roadmap of development](https://designsystem.gov.ae/resources/roadmap)

		## Report an issue

		To report a bug, an issue and for help, you can [submit an issue](https://github.com/TDRA-ae/aegov-dls/issues) on GitHub. We also encourage you to join our [GitHub discussions](https://github.com/orgs/TDRA-ae/discussions) for help from the community. For more information and details, you can also visit [tdra.gov.ae](https://tdra.gov.ae)

@aegov/design-system - npm Package Compare versions

New alerts

Fixed alerts

Improved metrics