Skip to content

Update @daffodil/design core directive docs #3646

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

Open
xelaint opened this issue Apr 24, 2025 · 1 comment · Fixed by #3678
Open

Update @daffodil/design core directive docs #3646

xelaint opened this issue Apr 24, 2025 · 1 comment · Fixed by #3678
Assignees
Labels
docs This issue is related to documentation package: design @daffodil/design
Milestone

Comments

@xelaint
Copy link
Member

xelaint commented Apr 24, 2025

📄 Documentation Request

What were you doing?

From a component API doc that uses DaffColorableDirective as a hostDirective, I don't know what options are available to me from DaffPalette unless I navigate to the DaffPalette page.

Expected behavior

The input doc of each directive should list out the available options.

i.e.

In DaffColorableDirective:

 /**
   * Sets the color on a component.
   * 
   * `
   */
  @Input() color: DaffPalette;

should be:

 /**
   * Sets the color on a component.
   * 
   * `'primary' | 'secondary' | 'tertiary' | 'light' | 'dark' | 'theme' | 'theme-contrast' | 'black' | 'white'`
   */
  @Input() color: DaffPalette;

Existing Documentation

Environment


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

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

Others:

@xelaint xelaint added the docs This issue is related to documentation label Apr 24, 2025
@xelaint xelaint self-assigned this Apr 24, 2025
@xelaint xelaint added this to the Daffodil v1.0 milestone Apr 24, 2025
@xelaint xelaint added the package: design @daffodil/design label Apr 24, 2025
@xelaint xelaint changed the title [DOCS] Update @daffodil/design core directive docs Update @daffodil/design core directive docs May 1, 2025
@xelaint
Copy link
Member Author

xelaint commented May 20, 2025

Reopened. Missing docs for:

  • Skeleton
  • Compact
  • Open

@xelaint xelaint reopened this May 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This issue is related to documentation package: design @daffodil/design
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant