Obelisco v2

Obelisco v2 es un Sistema de diseño basado en componentes para productos digitales de la Ciudad de Buenos Aires, diseñado para continuar la evolución de Obelisco en su segunda versión.

Este sistema brinda una mejor experiencia de usuario y simplifica el desarrollo de interfaces web al mantener una armonía digital enfocada en la experiencia de los usuarios, proporcionada por el Gobierno de la Ciudad de Buenos Aires (GCBA).

Con una amplia variedad de componentes, Obelisco v2 acelera la creación de aplicaciones elegantes y funcionales.

Cómo usarlo

Obelisco v2 se distribuye por medio del paquete publicado en NPM, Es recomendable usar este sistema para definir la versión a usar y poder actualizarla fácilmente.

Instalación

Para instalarlo puedes hacer uso de npm, yarn o pnpm:

npm i @gcba/obelisco-v2

yarn add @gcba/obelisco-v2

pnpm i @gcba/obelisco-v2

Actualización

Si Obelisco ya está instalado en el proyecto y necesitás actualizarlo a la última versión, en el directorio del proyecto hay que ejecutar:

npm update @gcba/obelisco-v2

Uso con CDN

<link href="https://cdn.jsdelivr.net/npm/@gcba/[email protected]/dist/styles.min.css" rel="stylesheet" />

Si no instalás Obelisco de forma local, podés incluir los estilos directamente desde nuestra CDN. Sólo tenés que reemplazar la sección de la url en la que figura "X.X.X" por el número de la versión que desees utilizar. Te recomendamos usar la versión más reciente.

Importación

Importar los estilos en el archivo principal del proyecto:

@import "@gcba/obelisco-v2/dist/styles.css";
o
<link rel="stylesheet" href="ruta/al/proyecto/dist/styles.css" />

Si estas utilizando versiones anteriores de webpack, (Webpack 4 o inferiores), el prefijo ~ es necesario:

@import "~@gcba/obelisco-v2/dist/styles.css";

Tipografías

Obelisco requiere las tipografías Nunito y Open sans disponibles en google fonts, para utilizarlas con su CDN podemos hacerlo de la siguiente forma:

<link href="https://fonts.googleapis.com/css2?family=Open+Sans:ital,wght@0,400;0,600;0,700;1,400&display=swap" rel="stylesheet" />
<link href="https://fonts.googleapis.com/css2?family=Nunito:wght@300;400;600;700&display=swap" rel="stylesheet" />

Iconografía

Obelisco utiliza las librerías de Boxicons y Material symbols que se pueden instalar de las siguientes maneras:

Boxicons con npm o CDN:

npm install boxicons

// Es importante que incluyas el import a Boxicons en tu hoja de estilos si lo usas via NPM
@import "boxicons/css/boxicons.min.css";

<link href='https://unpkg.com/[email protected]/css/boxicons.min.css' rel='stylesheet' />

Material Symbols con npm o CDN:

npm install material-symbols@latest

// Es importante que incluyas el import a Material Symbols en tu hoja de estilos si lo usas via NPM
@import "material-symbols/index.css";

<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Material+Symbols+Rounded:opsz,wght,FILL,GRAD@24,400,1,0"/>

Javascript

Como Obelisco está construido sobre bootstrap 5, debemos tener esas dependencias.

Un ejemplo de cómo importalas es:

<script src="https://cdn.jsdelivr.net/npm/@popperjs/[email protected]/dist/umd/popper.min.js" integrity="sha384-I7E8VVD/ismYTF4hNIPjVp/Zjvgyol6VFvRkX/vR+Vc4jQkC+hVqc2pM8ODewa9r" crossOrigin="anonymous"></script>
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/js/bootstrap.min.js" integrity="sha384-0pUGZvbkm6XF6gxjEnlmuGrJXVbNuzT9qBBavbLwCsOGabYfZo0T0to5eqruptLy" crossOrigin="anonymous"></script>

Desarrollo

En la wiki del repositorio está toda la información necesaria para entender cómo se organizan las diferentes partes del proyecto, cómo funciona y los procesos de trabajo que definimos.

Mantenimiento y colaboración

El mantenimiento y desarrollo de Obelisco lo hace el equipo de la Dirección General de Canales Digitales, pero lo utilizan tanto equipos de gobierno como proveedores externos.

Para agilizar y hacer más transparente el proceso, cualquier persona puede contribuir de varias formas o contactar al equipo Obelisco.

Mail de contacto: [email protected]