Code example generation for search page #381
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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,56 @@ | ||
| <template> | ||
| <div class="codebox"> | ||
| <pre v-highlightjs> | ||
| <code :class="language" :id="componentId"> | ||
| {{ code }} | ||
| </code> | ||
| </pre> | ||
| <button ref="copyButton" :data-clipboard-target="'#' + componentId">Copy</button> | ||
| </div> | ||
| </template> | ||
|
|
||
| <script> | ||
| import Clipboard from 'clipboard'; | ||
|
|
||
| export default { | ||
| name: "CodeBox", | ||
| props: { | ||
|
There was a problem hiding this comment. Both props should probably be required. |
||
| code: String, | ||
| language: String | ||
| }, | ||
| data() { | ||
| return { | ||
| componentId: `${this.language}Content` | ||
| } | ||
| }, | ||
| mounted() { | ||
| new Clipboard(this.$refs.copyButton); | ||
| }, | ||
| }; | ||
| </script> | ||
|
|
||
| <style scoped> | ||
| .codebox { | ||
| border: 1px solid #ccc; | ||
| padding: 16px; | ||
| border-radius: 8px; | ||
| } | ||
| .codebox button { | ||
| background-color: #007BFF; | ||
| color: #FFF; | ||
| padding: 5px 15px; | ||
| border: none; | ||
| border-radius: 5px; | ||
| cursor: pointer; | ||
| transition: background-color 0.3s; | ||
| } | ||
|
|
||
| .codebox button:hover { | ||
| background-color: #0056b3; | ||
| } | ||
| .codebox pre, .codebox code { | ||
| padding: 0; | ||
| margin: 0; | ||
| } | ||
|
|
||
| </style> | ||
This file contains hidden or 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,122 @@ | ||
| <template> | ||
| <b-tabs> | ||
| <b-tab title="Python"> | ||
| <CodeBox :code="pythonCode" language="python" /> | ||
| </b-tab> | ||
| <b-tab title="Javascript"> | ||
| <CodeBox :code="javascriptCode" language="javascript" /> | ||
| </b-tab> | ||
| <b-tab title="R"> | ||
| <CodeBox :code="rCode" language="r" /> | ||
| </b-tab> | ||
| </b-tabs> | ||
| </template> | ||
|
|
||
| <script> | ||
| import { BTabs, BTab } from 'bootstrap-vue'; | ||
| export default { | ||
| name: "SearchCode", | ||
| props: { | ||
| catalogHref: String, | ||
| filters: Object, | ||
| }, | ||
| components: { | ||
| BTab, | ||
| BTabs, | ||
| CodeBox: () => import('./CodeBox.vue'), | ||
| }, | ||
| data() { | ||
| return { | ||
| componentId: `${this.language}Content`, | ||
|
|
||
| pythonCode: null, | ||
| javascriptCode: null, | ||
| rCode: null | ||
|
|
||
| } | ||
| }, | ||
| methods: { | ||
| filterString() { | ||
| let obj = this.filters || {} | ||
| for (let key in obj) { | ||
| if (obj[key] === null || (Array.isArray(obj[key]) && obj[key].length === 0)) { | ||
| delete obj[key]; | ||
| } | ||
| } | ||
| return JSON.stringify(obj) | ||
| }, | ||
| generatePython() { | ||
| return ` | ||
| from pystac_client import Client | ||
|
|
||
| # Connect to STAC API | ||
| stac_endpoint = '${this.catalogHref}' | ||
| client = Client.open(stac_endpoint) | ||
|
|
||
| # Build query | ||
| query = ${this.filterString()} | ||
|
|
||
| # Perform search | ||
| search_result = client.search(query ) | ||
| ` | ||
| }, | ||
| generateJavascript() { | ||
| return ` | ||
| // Define the STAC API endpoint | ||
| const STAC_ENDPOINT = '${this.catalogHref}'; | ||
|
|
||
| // Define your search parameters | ||
| const searchParams = ${this.filterString()}; | ||
|
|
||
| // Perform the search | ||
| fetch(STAC_ENDPOINT, { | ||
| method: "POST", | ||
| headers: { | ||
| "Content-Type": "application/json" | ||
| }, | ||
| body: JSON.stringify(searchParams) | ||
| }) | ||
| .then(response => response.json()) | ||
| .then(data => { | ||
| console.log("STAC search results:", data); | ||
| }) | ||
| .catch(error => { | ||
| console.error("Error fetching STAC data:", error); | ||
| }); | ||
| ` | ||
| }, | ||
| generateR() { | ||
| return ` | ||
| from pystac_client import Client | ||
|
|
||
| # Connect to STAC API | ||
| stac_api_url = '${this.catalogHref}' | ||
| client = Client.open(stac_api_url) | ||
|
|
||
| # Build query | ||
| query = ${this.filterString()} | ||
|
|
||
| # Perform search | ||
| search_result = client.search(query) | ||
| ` | ||
| }, | ||
| updateCode() { | ||
|
There was a problem hiding this comment. It might be a bit better to only generate what's shown, not everything upfront, especially if we extend this. |
||
| this.pythonCode = this.generatePython() | ||
| this.javascriptCode = this.generateJavascript() | ||
| this.rCode = this.generateR() | ||
| } | ||
| }, | ||
| watch: { | ||
| filters: { | ||
| deep: true, | ||
| handler() { | ||
| this.updateCode(); | ||
| } | ||
| } | ||
| }, | ||
| mounted() { | ||
| this.updateCode(); | ||
| }, | ||
| }; | ||
| </script> | ||
|
|
||
| <style scoped> | ||
| </style> | ||
This file contains hidden or 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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We already use v-clipboard, can you re-use that instead of a new/this dependency?