chore: Update react and js templates with cleaner comments.

fourjuaneight · Jan 7, 2025 · 4bd04e9 · 4bd04e9
1 parent 307dbda
commit 4bd04e9
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 18 deletions.
diff --git a/templates/react/head.tsx b/templates/react/head.tsx
@@ -36,11 +36,6 @@ type Data = {
 
 /**
  * HTML Head
- * @component
- *
- * @param   {ILocation} location router location info
- *
- * @returns {React.FC}
  */
 const Head: React.FC<HeadProps> = ({ location }): React.FC => {
   const {

diff --git a/templates/react/images.tsx b/templates/react/images.tsx
@@ -26,14 +26,11 @@ interface ImageProps {
 /**
  * Static Image Query
  * Queries all images at a set max-width and allows filtering of specific image via props
- * @component
  *
- * @param   {string} alt      alt text
- * @param   {string} filename image relative filename
- * @param   {object} imgStyle img styles
- * @param   {object} style    wrapper container styles
- *
- * @returns {React.FC}        <Image filename={string} alt={string} style={object} imgStyle={object} />
+ * @param alt alt text
+ * @param filename image relative filename
+ * @param imgStyle img styles
+ * @param style wrapper container styles
  */
 const Image: React.FC<ImageProps> = ({
   alt,

diff --git a/templates/react/layout.tsx b/templates/react/layout.tsx
@@ -12,11 +12,6 @@ interface LayoutProps {
 
 /**
  * Main layout
- * @component
- *
- * @param   {LayoutProps} location router location info
- *
- * @returns {React.FC}             <Layout location={location} />
  */
 const Layout: React.FC<LayoutProps> = ({ children, location }): React.FC => (
   <>

diff --git a/templates/scripts/clipboard.ts b/templates/scripts/clipboard.ts
@@ -1,7 +1,9 @@
 /* eslint-disable quotes */
 const clip = document.querySelector('button.clip-btn');
 
-// create selection range for <code> element
+/**
+ * Create selection range for <code> element.
+ */
 clip.addEventListener('click', () => {
   const selection: Selection = window.getSelection();
   const range: Range = document.createRange();

diff --git a/templates/scripts/lazyload.ts b/templates/scripts/lazyload.ts
@@ -2,6 +2,9 @@ const imgs: NodeListOf<HTMLImageElement> = document.querySelectorAll(
   'img[data-lazy="true"]'
 );
 
+/**
+ * IntersectionObserver API
+ */
 let observer = new IntersectionObserver((entries, self) => {
   entries.forEach(entry => {
     if (entry.isIntersecting) {
@@ -15,6 +18,7 @@ let observer = new IntersectionObserver((entries, self) => {
   });
 });
 
+// Observe all images with `data-lazy` attribute
 if (imgs.length > 0) {
   imgs.forEach(img => {
     observer.observe(img);