API Reference: UI: Explore Component API #6444
Merged
Conversation
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
luvkapur
changed the title
GiladShoham
reviewed
Sep 14, 2022
…and interfaceDeclaration
davidfirst
previously approved these changes
Nov 1, 2022
odedre
reviewed
Nov 8, 2022
| @@ -0,0 +1 @@ | |||
| export * from './table-row'; | |||
| flex-direction: column; | ||
| overflow: auto; | ||
| height: 100%; | ||
| font-size: 14px; |
| export function useUpdatedUrlFromQuery(queryParams: APIRefQueryParams): string { | ||
| const query = useQuery(); | ||
| const location = useLocation() || { pathname: '/' }; | ||
| // @ts-ignore |
| width: 100%; | ||
| } | ||
| .apiNodeDetailsComment { | ||
| font-size: var(--bit-p-xs); |
| } | ||
| .apiNodeDetailsLocationContainer { | ||
| display: flex; | ||
| flex-direction: row; |
| @@ -0,0 +1,145 @@ | |||
| /* eslint-disable @typescript-eslint/no-unused-vars */ | |||
| @@ -0,0 +1,49 @@ | |||
| @import '~@teambit/ui-foundation.ui.constants.z-indexes/z-indexes.module.scss'; | |||
There was a problem hiding this comment.
seems to be copy pasted from split pane.
can we reuse the original component? or even its shared css?
| import { ConstructorSchema, SchemaNode } from '@teambit/semantics.entities.semantic-schema'; | ||
|
|
||
| export function transformSignature({ __schema, signature }: SchemaNode): string | undefined { | ||
| let displaySignature: string | undefined; |
There was a problem hiding this comment.
can we just return the value instead of mutating displaySignature?
| @@ -10,6 +10,7 @@ export const BasicButton = () => { | |||
| /** | |||
| * example of passing a JSX Element as a parameter | |||
| */ | |||
| // eslint-disable-next-line react/prop-types | |||
| @@ -12,6 +12,7 @@ | |||
| line-height: 1.2em; | |||
| padding-right: 8px; | |||
| font-size: var(--bit-p-xs); | |||
| line-height: 16px; | |||
There was a problem hiding this comment.
you already have line height. please remove this
odedre
approved these changes
Nov 8, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed Changes
APIReferenceUIRuntime: UI Runtime that extends the Component UI to add a new API Reference Tab, and allows users to override default renderers for each API nodeAPIReferencePage: Component UI Tab that renders the entire API for a given component versionAPIExplorer: An API file tree, grouped by Type (Classes, Enums, Functions, Interfaces, Variables, etc). Allows users to explore and navigate to a specific API nodeclassRenderertypeRendererinterfaceRenderervariableRendererfunctionRendererenumRendererunresolvedRenderertypeRefRenderertypeIntersectionRenderertypeUnionRendererparameterRenderertypeLiteralRendererinferenceTypeRenderertypeArrayRenderer