Security News
New Proposed CISA Mandate Would Require Critical Infrastructure to Report Ransom Payments Within 24 Hours
CISA has proposed a set of new rules that would require critical infrastructure to report cyber incidents and ransom payments.
@stackbit/annotations
Advanced tools
Stackbit annotations utils
Weekly downloads
Readme
This package includes several utilities to work with Stackbit annotations in React.
Stackbit annotations enable on-page editing experience for your site. Click here to learn more about Stackbit.
npm install @stackbit/annotations
import * as React from 'react';
import { toObjectId, toFieldPath } from '@stackbit/annotations';
export function MyComponent(props) {
return (
<div {...toObjectId(props.id)}>
<h1 {...toFieldPath('title')}>{props.title}</h1>
<img src={props.image} {...toFieldPath('image#@src')} />
{props.link && (
<a href={props.link.url} {...toFieldPath('link.url#@href', 'link.text')}>
{props.link.text}
</a>
)}
</div>
);
}
Output:
<div data-sb-object-id="...">
<h1 data-sb-field-path="title">...</h1>
<img src="..." data-sb-field-path="image#@src" />
<a href="..." data-sb-field-path="link.url#@href link.text">...</a>
</div>
When NODE_ENV
is set to production
, toObjectIds
and toFieldPath
will return empty objects, effectively removing any Stackbit annotations.
toObjectId
Takes a string and returns an object with that string inside the data-sb-object-id
property. When NODE_ENV
is set to production
, this function returns an empty object.
toObjectId('xyz');
// result: { 'data-sb-object-id': 'xyz' }
toFieldPath
Takes field-path and returns an object with all field-paths concatenated into the data-sb-field-path
property. Each field-path can be a string or a FieldPathDescriptor
. When NODE_ENV
is set to production
, this function returns an empty object.
toFieldPath('title', { objectId: 'xyz', fieldPath: 'url', xpath: '@href' });
// result: { 'data-sb-field-path': 'title xyz:url#@href' }
getObjectId
Takes an object and returns the value of the data-sb-object-id
property if it exists, otherwise returns undefined.
getObjectId({ 'data-sb-object-id': 'xyz' });
// result: 'xyz'
getFieldPath
Takes an object and returns the value of the data-sb-field-path
property if it exists, otherwise returns undefined.
getFieldPath({ 'data-sb-field-path': 'title' });
// result: 'title'
pickDataAttrs
Takes an object and returns a new object with only the properties that start with data-
getFieldPath({
foo: 'bar',
bar: 'foo',
'data-sb-object-id': 'xyz',
'data-sb-field-path': 'title'
});
// result:
// {
// 'data-sb-object-id': 'xyz',
// 'data-sb-field-path': 'title'
// }
FAQs
Stackbit annotations utils
The npm package @stackbit/annotations receives a total of 2,945 weekly downloads. As such, @stackbit/annotations popularity was classified as popular.
We found that @stackbit/annotations demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 19 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
CISA has proposed a set of new rules that would require critical infrastructure to report cyber incidents and ransom payments.
Security News
Redis is no longer OSS, breaking its explicit commitment to remain under the BSD 3-Clause License forever. This has angered contributors who are now working to fork the software.
Product
Socket AI now enables 'AI detected potential malware' alerts by default, ensuring users benefit from AI-powered state-of-the-art malware detection without needing to opt-in.