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] Inputs from hostDirectives in design components should be included in API docs #3500

Open
xelaint opened this issue Feb 13, 2025 · 0 comments · May be fixed by #3544
Open

[FEAT] Inputs from hostDirectives in design components should be included in API docs #3500

xelaint opened this issue Feb 13, 2025 · 0 comments · May be fixed by #3544
Assignees
Labels
package: daff.io @daffodil/daff.io tools: dgeni @daffodil/tools-dgeni
Milestone

Comments

@xelaint
Copy link
Member

xelaint commented Feb 13, 2025

💡 Feature request

Feature Name

Inputs from hostDirectives in design components should be included in API docs.

The Desired Behavior

i,e. in Callout, these inputs from hostDirectives should be included in API docs.

hostDirectives: [
    { directive: DaffArticleEncapsulatedDirective },
    { directive: DaffManageContainerLayoutDirective },
    {
      directive: DaffTextAlignableDirective,
      inputs: ['textAlignment'],
    },
    {
      directive: DaffCompactableDirective,
      inputs: ['compact'],
    },
    {
      directive: DaffColorableDirective,
      inputs: ['color'],
    },
  ],

All other information within these directives do not need to be exposed in the API docs. The enduser should only care about the input they can use.

Your Use Case

As a user, I would like to know what inputs from hostDirectives are available for use.

Prior Work

Environment


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

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

Others:

@xelaint xelaint added the feat a new feature, enhancement, or improvement label Feb 13, 2025
@xelaint xelaint added this to the Daffodil v1.0 milestone Feb 13, 2025
@xelaint xelaint added package: daff.io @daffodil/daff.io tools: dgeni @daffodil/tools-dgeni and removed feat a new feature, enhancement, or improvement labels Feb 13, 2025
@xelaint xelaint changed the title [FEAT] hostDirectives in design components should be included in API docs [FEAT] Inputs from hostDirectives in design components should be included in API docs Feb 13, 2025
@griest024 griest024 linked a pull request Mar 6, 2025 that will close this issue
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
package: daff.io @daffodil/daff.io tools: dgeni @daffodil/tools-dgeni
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants