JSPM

  • Created
  • Published
  • Downloads 10
  • Score
    100M100P100Q54890F
  • License MIT

A collection of reusable components designed for use in Sixbell Telco Angular projects

Package Exports

  • @sixbell-telco/sdk
  • @sixbell-telco/sdk/components/accordion
  • @sixbell-telco/sdk/components/avatar
  • @sixbell-telco/sdk/components/button
  • @sixbell-telco/sdk/components/card
  • @sixbell-telco/sdk/components/countdown
  • @sixbell-telco/sdk/components/dropdown
  • @sixbell-telco/sdk/components/dual-list
  • @sixbell-telco/sdk/components/file-upload/file-dropzone
  • @sixbell-telco/sdk/components/file-upload/file-uploader
  • @sixbell-telco/sdk/components/forms/checkbox
  • @sixbell-telco/sdk/components/forms/combobox
  • @sixbell-telco/sdk/components/forms/datepicker
  • @sixbell-telco/sdk/components/forms/form-error
  • @sixbell-telco/sdk/components/forms/input
  • @sixbell-telco/sdk/components/forms/radio
  • @sixbell-telco/sdk/components/forms/range
  • @sixbell-telco/sdk/components/forms/select
  • @sixbell-telco/sdk/components/forms/switch
  • @sixbell-telco/sdk/components/forms/textarea
  • @sixbell-telco/sdk/components/forms/toggle
  • @sixbell-telco/sdk/components/icon
  • @sixbell-telco/sdk/components/icon/material/baseline
  • @sixbell-telco/sdk/components/icon/material/outline
  • @sixbell-telco/sdk/components/icon/material/round
  • @sixbell-telco/sdk/components/icon/material/sharp
  • @sixbell-telco/sdk/components/link
  • @sixbell-telco/sdk/components/modal
  • @sixbell-telco/sdk/components/notification
  • @sixbell-telco/sdk/components/paginator
  • @sixbell-telco/sdk/components/product-card
  • @sixbell-telco/sdk/components/progress
  • @sixbell-telco/sdk/components/tab
  • @sixbell-telco/sdk/components/table
  • @sixbell-telco/sdk/components/toast
  • @sixbell-telco/sdk/components/tooltip
  • @sixbell-telco/sdk/components/wizard
  • @sixbell-telco/sdk/directives/typography
  • @sixbell-telco/sdk/package.json
  • @sixbell-telco/sdk/utils/cn
  • @sixbell-telco/sdk/utils/generators/uuid
  • @sixbell-telco/sdk/utils/pipes/extract-extension
  • @sixbell-telco/sdk/utils/pipes/to-bytes-extesion

Readme

Sixbell Telco SDK

We are thrilled to have you here. This SDK is designed to provide you with a comprehensive set of UI components to accelerate your development process. Whether you are building a small project or a large-scale application, our components are crafted to be flexible, customizable, and easy to integrate.

Explore the documentation, try out the examples, and start building amazing applications with Sixbell Telco SDK today!

Happy coding!

sixbell-telco-sdk-banner

Pre-requirements

  • Angular 18.X.X or later

Available Components

General components

Component Description
Accordion Expandable/collapsible content
Accordion Item Item within an accordion
Avatar User avatar display
Button Buttons for various actions
Card Container for content and actions
Countdown Countdown timer
Dropdown Dropdown menu for actions or links
Dual List Dual list for selecting items
File Uploader Upload files
File Dropzone Drag and drop file upload
Icon Display icons
Link Hyperlink component
Modal Modal dialog
Notification Display notifications
Paginator Pagination controls
Product Card Display product information
Progress Progress bar
Tab Tabbed navigation
Table Display tabular data
Toast Toast notifications
Tooltip Display tooltips
Wizard Step-by-step wizard

Forms specific components

Component Description
Checkbox Checkbox input
Combobox Combo box for selecting options
Datepicker Date selection input
Form Error Display form errors
Input Text input field
Radio Radio button input
Range Range slider input
Select Dropdown select input
Switch Toggle switch input
Textarea Multi-line text input
Toggle Toggle button input

Setup

We provide a CLI tool for automatic setup:

npx @sixbell-telco/cli init

This will automatically:

  • Install all necessary dependencies
  • Configure Tailwind CSS and Daisy UI
  • Set up required theme configurations

Note: The CLI tool is currently a work in progress and is not yet available. Coming soon!

Manual Setup

  1. Install dependencies:
npm i -D @sixbell-telco/sdk @tailwindcss/typography daisyui @midudev/tailwind-animations
  1. Configure Tailwind CSS (Tailwind guide)

  2. Add the provided configuration to your tailwind.config.js [See detailed config below]

/** @type {import('tailwindcss').Config} */

module.exports = {
  content: ['./src/**/*.{html,ts}', './node_modules/@sixbell-telco/sdk/**/*.{html,ts,js,mjs}'],
  theme: {
    extend: {
      colors: {
        'secondary-muted': 'rgba(var(--secondary-muted), <alpha-value>)',
        'secondary-muted-content': 'rgba(var(--secondary-muted-content), <alpha-value>)',
        'border-box': 'rgba(var(--border-box))',
        ring: 'rgba(var(--ring),  <alpha-value>)',
        'ring-accent': 'rgba(var(--ring-accent), <alpha-value>)',
        separator: 'rgba(var(--separtor), <alpha-value>)',
        'base-200-muted': 'rgba(var(--base-200-muted))',
      },
      fontFamily: {
        poppins: ['Poppins', 'sans-serif'],
        heading: ['Poppins', 'sans-serif'],
        body: ['Poppins', 'sans-serif'],
      },
      boxShadow: {
        primary: '0px 5px 5px 0px rgba(var(--shadow-primary))',
        secondary: '0px 2px 5px 0px rgba(var(--shadow-secondary))',
      },
      borderRadius: {
        'btn-xs': 'var(--rounded-btn-xs)',
        'btn-sm': 'var(--rounded-btn-sm)',
        'btn-md': 'var(--rounded-btn-md)',
        'btn-lg': 'var(--rounded-btn-lg)',
        'box-sm': 'var(--rounded-box-sm)',
        'box-md': 'var(--rounded-box-md)',
        'box-lg': 'var(--rounded-box-lg)',
      },
      fontWeight: {
        inherit: 'inherit',
      },
      transitionTimingFunction: {
        'ease-out-back': 'cubic-bezier(0.34, 1.56, 0.64, 1)',
        'ease-in-and-out-back': 'cubic-bezier(0.68, -0.55, 0.27, 1.55)',
      },
      animation: {
        'slide-in': 'slideIn 0.8s cubic-bezier(0.34, 1.56, 0.64, 1)',
        'slide-out': 'slideOut 0.8s cubic-bezier(0.34, 1.56, 0.64, 1)',
        'toast-slide-out': 'toastSlideOut 0.8s cubic-bezier(0.68, -0.55, 0.27, 1.55)',
        'fade-in': 'fadeIn 1s',
        'fade-out': 'fadeOut 1s',
      },
    },
  },
  daisyui: {
    themes: [
      {
        vivid_elegance: {
          // Daisy UI theme variables
          primary: '#4DD6ED',
          'primary-content': '#FFFFFF',
          secondary: '#d9dadd',
          'secondary-content': '#414756',
          accent: '#4DD6ED',
          'accent-content': '#FFFFFF',
          neutral: '#414756',
          'neutral-content': '#FFFFFF',
          'base-100': '#FFFFFF',
          'base-200': '#f6f6f6',
          'base-300': '#4DBED1',
          'base-content': '#1F2937',
          info: '#4DD6ED',
          'info-content': '#FFFFFF',
          success: '#4DD192',
          'success-content': '#FFFFFF',
          warning: '#DBD46C',
          'warning-content': '#414756',
          error: '#E72F40',
          'error-content': '#FFFFFF',
          // Custom colors
          '--secondary-muted': '237, 237, 237',
          '--secondary-muted-content': '65, 71, 86',
          '--shadow-primary': '77, 190, 209,  0.7',
          '--shadow-secondary': '186, 185, 185, 0.40',
          '--separtor': '217, 217, 217',
          '--border-box': '65, 71,68, 0.2',
          '--input-border': '186, 185, 185',
          '--ring': '186, 185, 185',
          '--ring-accent': '77, 214, 237',
          '--base-200-muted': '250, 250, 250, 0.2',
          // Daisy UI utility variables
          '--rounded-box': '1rem', // border radius rounded-box utility class, used in card and other large boxes
          '--rounded-btn': '0.5rem', // border radius rounded-btn utility class, used in buttons and similar element
          '--rounded-badge': '1.9rem', // border radius rounded-badge utility class, used in badges and similar
          '--animation-btn': '0.25s', // duration of animation when you click on button
          '--animation-input': '0.2s', // duration of animation for inputs like checkbox, toggle, radio, etc
          '--btn-focus-scale': '0.95', // scale transform of button when you focus on it
          '--border-btn': '1px', // border width of buttons
          '--tab-border': '1px', // border width of tabs
          '--tab-radius': '0.5rem', // border radius of tabs
          // Custom utility variables
          '--rounded-btn-xs': '0.3rem', // 4.8px
          '--rounded-btn-sm': '0.5rem', // 8px
          '--rounded-btn-md': '0.813rem', // 13px
          '--rounded-btn-lg': '2.25rem', // 36px
          '--rounded-box-sm': '0.5rem', // 8px
          '--rounded-box-md': '0.813rem', // 13px
          '--rounded-box-lg': '2.25rem', // 36px
        },
      },
    ],
  },
  plugins: [require('@midudev/tailwind-animations'), require('@tailwindcss/typography'), require('daisyui')],
};
  1. Below tailwind decorators in your global styles file add
@import 'node_modules/@sixbell-telco/sdk/_index.scss';

With that configuration the library custom CSS will be loaded

  1. Microfrontend Configuration (Required for Microfrontends Only)

Add the following path mapping to your tsconfig.json file under compilerOptions.paths:

"@sixbell-telco/sdk/*": ["./node_modules/@sixbell-telco/sdk/*"]

Complete example of a tsconfig.json:

{
  "compileOnSave": false,
  "compilerOptions": {
    "paths": {
      "@sixbell-telco/sdk/*": ["./node_modules/@sixbell-telco/sdk/*"]
      // ... other path mappings
    }
    // ... other compiler options
  }
}

This configuration ensures proper module resolution in microfrontend architectures.

  1. VSCode Settings (Optional)

For VSCode users, it is recommended to install the official Tailwind CSS extension and add the following to your settings.json file:

  "tailwindCSS.classAttributes": [
    "class",
    "className",
    "ngClass",
    "class:list",
    "classes",
    "contentClasses",
    "containerClasses",
    "buttonClasses",
    "menuClasses",
    "iconClasses",
    "leftTableContentClasses",
    "leftTableContainerClasses",
    "rightTableContentClasses",
    "rightTableContainerClasses",
    "titleClasses",
    "actionsClasses"
  ],
  "tailwindCSS.experimental.classRegex": [
    ["cva\\(([^)]*)\\)", "[\"'`]([^\"'`]*).*?[\"'`]"],
    ["cx\\(([^)]*)\\)", "(?:'|\"|`)([^']*)(?:'|\"|`)"],
    ["cn\\(([^)]*)\\)", "(?:'|\"|`)([^']*)(?:'|\"|`)"]
  ]

With those settings VSCode will pick the library custom attributes to give class intellisense

Usage Example

Here's a basic example of using a button component:

// app.component.ts
import { ButtonComponent } from '@sixbell-telco/sdk/components/button';

@Component({
  imports: [ButtonComponent],
  template: `
    <div>
    <h1>Awesome button</h2>
    <st-button label="Click me!" variant="primary" padding="normal" shape="round-sm" />
    </div>
  `
})

Documentation

For detailed component documentation, visit our Storybook

Note: Our Storybook documentation is currently a work in progress and will be available soon!

Last update

This file was last updated on November 22nd, 2024.