-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added documentation for placeholder components (#486)
- Loading branch information
Showing
20 changed files
with
375 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
--- | ||
title: Section | ||
description: A Section serves as a versatile container component, encapsulating an HTML section element. | ||
category: "collections" | ||
links: | ||
source: https://github.com/gsoft-inc/wl-hopper/blob/main/packages/components/src/Section/src/Section.tsx | ||
--- | ||
|
||
Section is a subcomponent of [Listbox](./Listbox), it's used within [Combobox](./ComboBox) and [Select](./Select). | ||
|
||
<Example src="Section/docs/preview" isOpen /> | ||
|
||
<FeatureFlag flag="next"> | ||
## Guidelines | ||
|
||
TODO: If we have some guidelines about this component's usage | ||
|
||
### Accessibility ? | ||
|
||
TODO: If we have some guidelines about this component and accessibility | ||
</FeatureFlag> | ||
|
||
## Anatomy | ||
|
||
### Composed Components | ||
|
||
A `Section` uses the following components. | ||
|
||
#### Listbox | ||
|
||
- [ListboxItem](./Listbox#listboxitem) | ||
- [Header](./Header) | ||
|
||
#### Combobox | ||
|
||
- [ComboBoxOption](./ComboBox#comboboxoption) | ||
- [Header](./Header) | ||
|
||
#### Select | ||
|
||
- [SelectOption](./Select#selectoption) | ||
- [Header](./Header) | ||
|
||
<FeatureFlag flag="rc"> | ||
|
||
TODO: We have anatomy screenshots from the Figma, we could most likely use them here | ||
|
||
### Concepts | ||
|
||
TODO: links to related concepts | ||
</FeatureFlag> | ||
|
||
<FeatureFlag flag="next"> | ||
## Advanced customization | ||
|
||
### Contexts | ||
TODO: Example of context + content about the context | ||
|
||
### Custom Children | ||
|
||
TODO: Example of passing custom childrens to the components to fake a slot | ||
|
||
### Custom Component | ||
|
||
TODO: Example of creating a custom version of this component | ||
</FeatureFlag> | ||
|
||
## Props | ||
|
||
<PropTable component="Section" /> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
--- | ||
title: Content | ||
description: A placeholder for the main content section of a component. | ||
category: "placeholders" | ||
links: | ||
source: https://github.com/gsoft-inc/wl-hopper/blob/main/packages/components/src/layout/src/Content.tsx | ||
--- | ||
|
||
A content placeholder component provides no specific styling by itself, but receives styling from the parent container. In addition, a content placeholder will be automatically placed within the container's layout according to Hopper guidelines. | ||
|
||
<Example src="layout/docs/content/preview" isOpen /> | ||
|
||
<FeatureFlag flag="next"> | ||
## Guidelines | ||
|
||
TODO: If we have some guidelines about this component's usage | ||
|
||
### Accessibility ? | ||
|
||
TODO: If we have some guidelines about this component and accessibility | ||
</FeatureFlag> | ||
|
||
<FeatureFlag flag="rc"> | ||
## Anatomy | ||
|
||
TODO: We have anatomy screenshots from the Figma, we could most likely use them here | ||
|
||
### Concepts | ||
|
||
TODO: links to related concepts | ||
</FeatureFlag> | ||
|
||
<FeatureFlag flag="next"> | ||
## Advanced customization | ||
|
||
### Contexts | ||
TODO: Example of context + content about the context | ||
|
||
### Custom Children | ||
|
||
TODO: Example of passing custom childrens to the components to fake a slot | ||
|
||
### Custom Component | ||
|
||
TODO: Example of creating a custom version of this component | ||
</FeatureFlag> | ||
|
||
## Props | ||
|
||
<PropTable component="Content" /> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
--- | ||
title: Footer | ||
description: A placeholder for a footer section. | ||
category: "placeholders" | ||
links: | ||
source: https://github.com/gsoft-inc/wl-hopper/blob/main/packages/components/src/layout/src/Footer.tsx | ||
--- | ||
|
||
A footer placeholder component provides no specific styling by itself, but receives styling from the parent container. In addition, a footer placeholder will be automatically placed within the container's layout according to Hopper guidelines. | ||
|
||
<Example src="layout/docs/footer/preview" isOpen /> | ||
|
||
<FeatureFlag flag="next"> | ||
## Guidelines | ||
|
||
TODO: If we have some guidelines about this component's usage | ||
|
||
### Accessibility ? | ||
|
||
TODO: If we have some guidelines about this component and accessibility | ||
</FeatureFlag> | ||
|
||
<FeatureFlag flag="rc"> | ||
## Anatomy | ||
|
||
TODO: We have anatomy screenshots from the Figma, we could most likely use them here | ||
|
||
### Concepts | ||
|
||
TODO: links to related concepts | ||
</FeatureFlag> | ||
|
||
<FeatureFlag flag="next"> | ||
## Advanced customization | ||
|
||
### Contexts | ||
TODO: Example of context + content about the context | ||
|
||
### Custom Children | ||
|
||
TODO: Example of passing custom childrens to the components to fake a slot | ||
|
||
### Custom Component | ||
|
||
TODO: Example of creating a custom version of this component | ||
</FeatureFlag> | ||
|
||
## Props | ||
|
||
<PropTable component="Footer" /> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
--- | ||
title: Header | ||
description: A placeholder for an header section. | ||
category: "placeholders" | ||
links: | ||
source: https://github.com/gsoft-inc/wl-hopper/blob/main/packages/components/src/Header/src/Header.tsx | ||
--- | ||
|
||
An header placeholder component provides no specific styling by itself, but receives styling from the parent container. In addition, an header placeholder will be automatically placed within the container's layout according to Hopper guidelines. | ||
|
||
<Example src="Header/docs/preview" /> | ||
|
||
<FeatureFlag flag="next"> | ||
## Guidelines | ||
|
||
TODO: If we have some guidelines about this component's usage | ||
|
||
### Accessibility ? | ||
|
||
TODO: If we have some guidelines about this component and accessibility | ||
</FeatureFlag> | ||
|
||
<FeatureFlag flag="rc"> | ||
## Anatomy | ||
|
||
TODO: We have anatomy screenshots from the Figma, we could most likely use them here | ||
|
||
### Concepts | ||
|
||
TODO: links to related concepts | ||
</FeatureFlag> | ||
|
||
<FeatureFlag flag="next"> | ||
## Advanced customization | ||
|
||
### Contexts | ||
TODO: Example of context + content about the context | ||
|
||
### Custom Children | ||
|
||
TODO: Example of passing custom childrens to the components to fake a slot | ||
|
||
### Custom Component | ||
|
||
TODO: Example of creating a custom version of this component | ||
</FeatureFlag> | ||
|
||
## Props | ||
|
||
<PropTable component="Header" /> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.