Skip to content

@daffodil/design Core Utilities API Docs #4330

@damienwebdev

Description

@damienwebdev

We need a page in daff.io that lists the contents of https://github.com/graycoreio/daffodil/tree/develop/libs/design/src/core as a single page where each folder is a heading. Within that heading, we optionally have a brief description / feature documentation that covers how that feature is used. That comes from a README.md in each of those folders.

Otherwise, that section contains the API docs of the tokens in that folder.

For example (as markdown):

Article Encapsulated

DaffArticleEncapsulatedDirective

import { DaffArticleEncapsulatedDirective } from '@daffodil/design'

Docblock contents

@Directive()
export class DaffArticleEncapsulatedDirective {}

Breakpoints

The breakpoints module defines a standardized set of CSS/viewport breakpoints used across Daffodil's design components to ensure consistent responsive behavior. It allows components to react to screen size changes in a unified way.

DaffBreakpoints

import { DaffBreakpoints } from '@daffodil/design';

Doc block contents

export enum DaffBreakpoints {
  DESKTOP = DaffBreakpoints.DESKTOP,
  LAPTOP = DaffBreakpoints.LAPTOP,
  SMALL_LAPTOP = DaffBreakpoints.SMALL_LAPTOP,
  BIG_TABLET = DaffBreakpoints.BIG_TABLET,
  TABLET = DaffBreakpoints.TABLET,
  MOBILE = DaffBreakpoints.MOBILE,
}

Important constraints

  • The item heading should be the "Title Case" version of the folder name

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions