django htmx patterns

รูปแบบ Django + htmx

repo นี้เป็นการรวบรวมรูปแบบที่ฉันใช้และพัฒนาอย่างคร่าวๆ และพร้อมใช้งานเมื่อเขียนโปรเจ็กต์ Django ที่ใช้ htmx พร้อมโค้ดตัวอย่างที่สมบูรณ์

เอกสารนี้มีจุดประสงค์เพื่อดูบน GitHub: https://github.com/spookylukey/django-htmx-patterns/ และโค้ดสามารถเรียกใช้ในเครื่องได้หากจำเป็น

จุดมุ่งหมายของฉันคือการจัดทำเอกสารและแบ่งปัน:

1. รูปแบบพื้นฐานและโฟลว์การควบคุมที่จำเป็น
2. การปรับปรุงบางอย่างที่เราสามารถทำได้ด้วยยูทิลิตี้บางอย่าง

รหัสที่แสดงขึ้นอยู่กับ Django และ htmx เท่านั้น เว้นแต่จะระบุไว้เป็นอย่างอื่น ฉันจะไม่บรรจุมันไว้เป็นห้องสมุด แต่กลับถูกเผยแพร่สู่สาธารณสมบัติ และคุณควรคัดลอกและวางตามความต้องการของคุณเอง (ดูเอกสาร "แนวทาง" ว่าทำไม)

มีแพ็คเกจ Django บางตัวที่ให้ทางลัดสำหรับบางสิ่งที่กล่าวถึงในที่นี้ เช่น django-htmx แต่ฉันจะไม่ใช้แพ็คเกจใด ๆ เพื่อความชัดเจน

สารบัญ

• เข้าใกล้
• เทมเพลตฐาน
• ส่วนหัว
• โพสต์คำขอ
• บางส่วนโดยใช้เทมเพลตแยกกัน
• แยกบางส่วนด้วยมุมมองเดียว
• บางส่วนแบบอินไลน์
• มุมมองเดียวพร้อมการดำเนินการรวมกัน
• ดูการรีสตาร์ท
• รูปแบบฟังก์ชั่น django
• กล่องโต้ตอบโมดอล
• การตรวจสอบแบบฟอร์ม

เรื่องนี้กำลังดำเนินการอยู่ครับ จะพยายามอัพเดทต่อไปครับ ประชาสัมพันธ์ยินดีต้อนรับ.

tl;ดร

การสนับสนุนที่ใหญ่ที่สุดใน repo นี้คือ:

• อินไลน์บางส่วนพร้อมการเลือกบล็อกในเทมเพลต

  นี่คือรูปแบบที่ช่วยให้คุณสามารถรวมส่วนต่างๆ ของหน้าไว้ด้วยกันเพื่อ "ลักษณะการทำงานในท้องถิ่น" ที่ยอดเยี่ยม และหลีกเลี่ยงไม่ให้โค้ดมุมมองต้องรู้สิ่งใดๆ เกี่ยวกับเทมเพลตส่วนย่อย/บางส่วนที่กำลังใช้งานอยู่ การเปลี่ยนแปลงโค้ดเทมเพลตสำหรับ htmx มักจะเป็นเรื่องของการห่อบางส่วนของเทมเพลตใน block เทมเพลต Django และเพิ่มแอตทริบิวต์ htmx มาตรฐาน การเปลี่ยนแปลงโค้ดมุมมองสำหรับ htmx มักจะเป็นเพียงการเพิ่มมัณฑนากรเดียวในฟังก์ชันมุมมอง: @for_htmx(use_block_from_params=True)

  รูปแบบนี้สร้างความแตกต่างอย่างมากต่อการใช้งาน htmx ใน Django

• ตัวอย่างแบบเต็มของการตรวจสอบความถูกต้องของแบบฟอร์ม htmx แบบฟิลด์ต่อฟิลด์ ในขณะที่ยังคงรักษา Form abstraction ของ Django และคุณประโยชน์ทั้งหมดไว้

• รูปแบบที่ดีสำหรับการทำกิริยาช่วย

ความต้องการ

• จังโก้

• htmx (ดูเทมเพลตฐานสำหรับเอกสารการติดตั้งที่แนะนำ)

• รูปแบบที่ดีที่สุดที่นี่ต้องใช้ django-render-block:

   pip ติดตั้ง django-render-block
  

สัตว์ประหลาด

โค้ดตัวอย่างของฉันมีสัตว์ประหลาดที่น่าเศร้าและมีความสุขที่สามารถกอดหรือเตะเพื่อเปลี่ยนสถานะได้ โปรดทราบว่าฉันไม่สนับสนุนการเตะสัตว์ประหลาด และไม่แนะนำให้กอดพวกมัน

โฟลเดอร์รหัส

ในโฟลเดอร์โค้ดคือแอปสาธิตซึ่งมีตัวอย่างการทำงานเต็มรูปแบบของทุกสิ่งในเอกสาร

หากต้องการติดตั้งในเครื่อง ให้สร้างและเปิดใช้งาน virtualenv จากนั้นทำ:

 รหัสซีดี
pip ติดตั้ง -r ข้อกำหนด.txt
หลาม Manage.py โยกย้าย
หลาม Manage.py รันเซิร์ฟเวอร์

ข้อเสนอแนะ

ยินดีรับฟังความคิดเห็นของคุณ! ติดดาว repo นี้ถ้าคุณชอบ และโปรดแบ่งปันแนวคิดในการสนทนา

ลิงค์

แหล่งข้อมูล htmx ที่ดีอื่น ๆ :

• วิธีสร้างแบบฟอร์ม Django (โดยใช้ HTMX) ใน 90 วินาที - โพสต์สั้นๆ ง่ายๆ (และวิดีโอ) ที่แสดงวิธีเริ่มใช้ HTMX กับ Django อย่างรวดเร็ว
• วิธีใช้ htmx ใน Django - โพสต์บล็อกการสอน
• django-htmx - ไลบรารียูทิลิตี้พร้อมเอกสารที่เป็นประโยชน์
• django-htmx-fun - ตัวอย่างแอปพลิเคชันที่มี Django/htmx
• django-siteajax - มีแนวคิดที่คล้ายกันกับ repo นี้

หากคุณชอบ repo นี้ คุณอาจได้รับความช่วยเหลือจากแหล่งข้อมูลอื่นๆ ของฉัน:

• django-functest
• Django Views — วิธีที่ถูกต้อง