Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FEAT] Normalize input interfaces and attributes for design components #763

Closed
14 of 16 tasks
xelaint opened this issue Apr 3, 2020 · 3 comments
Closed
14 of 16 tasks
Assignees
Labels
feat a new feature, enhancement, or improvement p1 critical priority package: design @daffodil/design
Milestone

Comments

@xelaint
Copy link
Member

xelaint commented Apr 3, 2020

💡 Feature request

Feature Name

Normalize input interfaces and attributes for design components.

The Desired Behavior

Create a list of input interfaces and attributes that will be used across the board in @daffodil/design.

Properties to AVOID (too similar to CSS properties):

  • align
  • alignment
  • horizontalAlignment
  • fontSize
  • fontFamily

Exceptions:

  • color

Known Valid Properties:

  • opened: boolean;
  • fullscreen: boolean;
  • size: xs | sm | md | lg | xl

Size (global interface):
Not all sizes need to be exported and used.

export type DaffSizeSmallType = 'sm'
export type DaffSizeMediumType = 'md'
export type DaffSizeLargeType = 'lg'
export type DaffSizeXLargeType = 'xl'

export type DaffSizeAllType = DaffSizeXSmallType | DaffSizeSmallType | DaffSizeMediumType | DaffSizeLargeType | DaffSizeXLargeType

Global Interfaces to Create

  • size
  • skeleton: boolean; | DaffSkeletonble
  • mutating: boolean; | DaffMutable
  • DaffCompactable
  • DaffOpenable
  • DaffSelectable
  • Disablable and Focusable interfaces for daff-form-field

Card Types

  • daff-card
  • daff-raised-card
  • daff-stroked-card

Link Set

  • Basic & stylized variants (names TBD, after components are updated to reflect correct style)

Feature

  • Deprecate DaffFeatureComponent

Need to Deprecate

  • DaffHeroLayout
  • DaffHeroSize (size will be a global interface)
  • DaffCalloutLayout
  • DaffCalloutSize (size will be a global interface)
  • DaffListAppearance

center type? Fixed with textAlignment (#1502)

  • We need a way to provide centering option (horizontally). The inline-block update to hero/callout did not work.

Your Use Case

As a developer, I'd like to maintain consistency in defining input interfaces and attributes throughout the design package.

Prior Work

Environment


Daffodil version: X.Y.Z
Angular version: X.Y.Z 

 
For Tooling issues:
- Node version: XX  
- Platform:  

Others:

@xelaint xelaint added feat a new feature, enhancement, or improvement package: design @daffodil/design labels Apr 3, 2020
@xelaint xelaint added this to the v0.8.0 - The Design Package V2 milestone Apr 3, 2020
@xelaint xelaint changed the title [FEAT] Refine attribute names for component input variants. [FEAT] Refine attribute names for component input properties. Apr 3, 2020
@xelaint xelaint changed the title [FEAT] Refine attribute names for component input properties. [FEAT] Normalize input interfaces and attributes for design components Apr 8, 2020
@xelaint xelaint pinned this issue Feb 2, 2021
@xelaint xelaint mentioned this issue Apr 13, 2022
3 tasks
@xelaint xelaint unpinned this issue Nov 30, 2023
@AnnieMi888 AnnieMi888 added the p1 critical priority label Dec 19, 2023
@xelaint
Copy link
Member Author

xelaint commented Jul 11, 2024

TODO: Document all the interfaces in design components and see which ones need to be created or implement existing interfaces

@xelaint
Copy link
Member Author

xelaint commented Jul 11, 2024

@damienwebdev the list in the original issue is correct. DaffOpenable and DaffSelectable are the only properties remaining in design that should be created into interfaces.

@damienwebdev
Copy link
Member

Closing as 95% of the work is completed and there are open tickets for the remaining items. #3019 #3020 are the last pieces.

@github-project-automation github-project-automation bot moved this from To do to Done in The Design Library Aug 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feat a new feature, enhancement, or improvement p1 critical priority package: design @daffodil/design
Projects
Development

No branches or pull requests

3 participants