Earthdata Search Components: Metadata Preview

For the NASA Access application and project setup, see Access Readme

About

A React plugin for displaying CMR Concept Metadata

Installation

npm install @edsc/metadata-preview

Usage

After installing you can use the component in your code.

Note: You will need Bootstrap 5 CSS imported into your application, those styles are not provided by this library.

import { CollectionPreview } from '@edsc/metadata-preview'

// Include this CSS for the Leaflet map to work correctly
import '@edsc/metadata-preview/dist/style.min.css'

const Component = () => {
  return (
    <CollectionPreview
      collection={collectionMetadataObject}
      conceptId="C100000-EXAMPLE"
    />
  )
}

import { ServicePreview } from '@edsc/metadata-preview'

const Component = () => {
  return (
    <ServicePreview
      conceptId="S100000-EXAMPLE"
      service={serviceMetadataObject}
    />
  )
}

import { ToolPreview } from '@edsc/metadata-preview'

const Component = () => {
  return (
    <ToolPreview
      conceptId="T100000-EXAMPLE"
      tool={toolMetadataObject}
    />
  )
}

import { VariablePreview } from '@edsc/metadata-preview'

const Component = () => {
  return (
    <VariablePreview
      conceptId="V100000-EXAMPLE"
      variable={variableMetadataObject}
    />
  )
}

Props

| Prop | Type | Required | Default Value | Description | ---- |:----:|:--------:|:-------------:| ----------- conceptId | String/Number | true | | ID for concept being displayed. collection/service/tool/variable | Object | true | | Concept metadata. The format of this metadata should be what is return from cmr-graphql. isPlugin | Boolean | false | true | Is the preview being loaded from the plugin version (vs the Access app version). Should always be true for this library. conceptType | String | false | collection/service/tool/variable | Concept type of the metadata being displayed. <concept> vs <concept>Draft. conceptUrlTemplate | String | false | /{conceptType}/{conceptId} | URL Template used for linking to associated concepts within the preview.

Contributing

See CONTRIBUTING.md

License

Copyright © 2007-2023 United States Government as represented by the Administrator of the National Aeronautics and Space Administration. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.