-
-
Notifications
You must be signed in to change notification settings - Fork 5.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Endpoint page: improve formatting Cherry-picked from #2906 (conflicts with that) Partly addresses #2837 but does not resolve it * Add badge customizer to the endpoint page * Clean lint
- Loading branch information
1 parent
24945ad
commit 90f8ad5
Showing
9 changed files
with
195 additions
and
143 deletions.
There are no files selected for viewing
File renamed without changes.
File renamed without changes.
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,159 @@ | ||
| import React from 'react' | ||
| import PropTypes from 'prop-types' | ||
| import clipboardCopy from 'clipboard-copy' | ||
| import { staticBadgeUrl } from '../../lib/badge-url' | ||
| import { generateMarkup } from '../../lib/generate-image-markup' | ||
| import { Badge } from '../common' | ||
| import PathBuilder from './path-builder' | ||
| import QueryStringBuilder from './query-string-builder' | ||
| import RequestMarkupButtom from './request-markup-button' | ||
| import CopiedContentIndicator from './copied-content-indicator' | ||
|
|
||
| export default class Customizer extends React.Component { | ||
| static propTypes = { | ||
| // This is an item from the `examples` array within the | ||
| // `serviceDefinition` schema. | ||
| // https://github.com/badges/shields/blob/master/services/service-definitions.js | ||
| baseUrl: PropTypes.string.isRequired, | ||
| title: PropTypes.string.isRequired, | ||
| pattern: PropTypes.string.isRequired, | ||
| exampleNamedParams: PropTypes.object.isRequired, | ||
| exampleQueryParams: PropTypes.object.isRequired, | ||
| defaultStyle: PropTypes.string, | ||
| } | ||
|
|
||
| indicatorRef = React.createRef() | ||
|
|
||
| state = { | ||
| path: '', | ||
| link: '', | ||
| message: undefined, | ||
| } | ||
|
|
||
| get baseUrl() { | ||
| const { baseUrl } = this.props | ||
| if (baseUrl) { | ||
| return baseUrl | ||
| } else { | ||
| // Default to the current hostname for when there is no `BASE_URL` set | ||
| // at build time (as in most PaaS deploys). | ||
| const { protocol, hostname } = window.location | ||
| return `${protocol}//${hostname}` | ||
| } | ||
| } | ||
|
|
||
| generateBuiltBadgeUrl() { | ||
| const { baseUrl } = this | ||
| const { path, queryString } = this.state | ||
|
|
||
| const suffix = queryString ? `?${queryString}` : '' | ||
| return `${baseUrl}${path}.svg${suffix}` | ||
| } | ||
|
|
||
| renderLivePreview() { | ||
| // There are some usability issues here. It would be better if the message | ||
| // changed from a validation error to a loading message once the | ||
| // parameters were filled in, and also switched back to loading when the | ||
| // parameters changed. | ||
| const { baseUrl } = this.props | ||
| const { pathIsComplete } = this.state | ||
| let src | ||
| if (pathIsComplete) { | ||
| src = this.generateBuiltBadgeUrl() | ||
| } else { | ||
| src = staticBadgeUrl( | ||
| baseUrl, | ||
| 'preview', | ||
| 'some parameters missing', | ||
| 'lightgray' | ||
| ) | ||
| } | ||
| return ( | ||
| <p> | ||
| <Badge display="block" src={src} /> | ||
| </p> | ||
| ) | ||
| } | ||
|
|
||
| copyMarkup = async markupFormat => { | ||
| const { title } = this.props | ||
| const { link } = this.state | ||
|
|
||
| const builtBadgeUrl = this.generateBuiltBadgeUrl() | ||
| const markup = generateMarkup({ | ||
| badgeUrl: builtBadgeUrl, | ||
| link, | ||
| title, | ||
| markupFormat, | ||
| }) | ||
|
|
||
| try { | ||
| await clipboardCopy(markup) | ||
| } catch (e) { | ||
| this.setState({ | ||
| message: 'Copy failed', | ||
| markup, | ||
| }) | ||
| return | ||
| } | ||
|
|
||
| this.setState({ markup }) | ||
| this.indicatorRef.current.trigger() | ||
| } | ||
|
|
||
| renderMarkupAndLivePreview() { | ||
| const { indicatorRef } = this | ||
| const { markup, message, pathIsComplete } = this.state | ||
|
|
||
| return ( | ||
| <div> | ||
| {this.renderLivePreview()} | ||
| <CopiedContentIndicator ref={indicatorRef} copiedContent="Copied"> | ||
| <RequestMarkupButtom | ||
| isDisabled={!pathIsComplete} | ||
| onMarkupRequested={this.copyMarkup} | ||
| /> | ||
| </CopiedContentIndicator> | ||
| {message && ( | ||
| <div> | ||
| <p>{message}</p> | ||
| <p>Markup: {markup}</p> | ||
| </div> | ||
| )} | ||
| </div> | ||
| ) | ||
| } | ||
|
|
||
| handlePathChange = ({ path, isComplete }) => { | ||
| this.setState({ path, pathIsComplete: isComplete }) | ||
| } | ||
|
|
||
| handleQueryStringChange = ({ queryString, isComplete }) => { | ||
| this.setState({ queryString }) | ||
| } | ||
|
|
||
| render() { | ||
| const { | ||
| pattern, | ||
| exampleNamedParams, | ||
| exampleQueryParams, | ||
| defaultStyle, | ||
| } = this.props | ||
|
|
||
| return ( | ||
| <form action=""> | ||
| <PathBuilder | ||
| pattern={pattern} | ||
| exampleParams={exampleNamedParams} | ||
| onChange={this.handlePathChange} | ||
| /> | ||
| <QueryStringBuilder | ||
| exampleParams={exampleQueryParams} | ||
| defaultStyle={defaultStyle} | ||
| onChange={this.handleQueryStringChange} | ||
| /> | ||
| <div>{this.renderMarkupAndLivePreview()}</div> | ||
| </form> | ||
| ) | ||
| } | ||
| } |
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
File renamed without changes.
File renamed without changes.
File renamed without changes.
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.